Runrun.it API Documentation

How to authenticate to use the API

Every request to the API should be sent with the correct authentication headers, app_key and user_token:

    curl "https://runrun.it/api/v1.0/users" -X GET \
      -H "App-Key: f9c650c98eeb28e345e0a38a184d20cb" \
      -H "User-Token: roBknmkPI0ALmwkRuC1q"

Whenever you send the incorrect information on app_key or user_token, the response will be 401 Unauthorized. The user_token is unique to each user and allows an agent to act on behalf of that user on Runrun.it. The app_key identifies a whole account, and cannot be changed through the GUI.

How to access your API authentication keys

API access is a premium feature only available to customers of certain paid accounts. To see which plans include API access check here. However developers with ideas for apps taking advantage of Runrun.it are always welcome to contact help@runrun.it about setting up a test account with API access.

  1. Go to Integration and Apps on Runrun.it Integration and Apps
  2. Then look for "API and Webhooks" and click Open Api and Webhooks
  3. Your app_key will be displayed next to the user_token Get application key and user token

Data format

All responses will be valid JSON. Requests should be in JSON as well (although for most actions form-encoded data is accepted as well).

All dates will be in ISO 8601 format. The time zones, if specified, will take into account when doing date operations. Another thing to be mentioned is that you need to urlencode your dates if it does contain special characters like + to specify time zones.

Request limit

There is a maximum limit of 100 requests per minute. If this limit is reached, it will be necessary to wait 1 minute to make new requests. In this case, the response will return the HTTP status code 429 with the following headers:

  • "RateLimit-Limit" → request limit
  • "RateLimit-Remaining" → remaining requests to reach the limit
  • "RateLimit-Reset" → date when the limit will be restored

Excessive use of the API will result in the offending app_key being revoked to ensure the quality of service for other users.

Pagination

Overview

Runrun.it API uses pagination to manage large sets of data efficiently. This section explains the use of headers and query parameters for pagination, along with a practical guide for implementation.

Headers

  • X-Item-Range: Indicates the range of items in the current response. The format is items {first_position}-{last_position}/{total}.
  • Link: Provides hypermedia links for navigation:
    • rel="self": The current page.
    • rel="prev": The previous page (if applicable).
    • rel="next": The next page (if available).
    • rel="last": The last page in the dataset.
  • X-Item-Without-View-Permission (optional): Shows the count of items not viewable due to permissions.

Query Parameters

  • page: Specifies the page number (starts from 1). If out of range, defaults to 1.
  • limit: Limits the number of items per page. The default and maximum limit is 100.
  • offset: Determines the starting point for data retrieval.

Practical Usage

  1. Initial Request: Start with your API call without specific page, limit, or offset.
  2. Analyzing the Response: Check the X-Item-Range and Link headers. The Link header includes navigation links such as self, prev, next, and last.
  3. Navigating Through Pages: Use the URL in the rel="next" link from the Link header for subsequent requests. Continue until this link is absent, indicating the last page.
  4. Optional Parameters: Customize the limit to change the number of items per page and use offset to start from a specific point in the dataset.

Notes

  • Pagination is based on RFC 7233 and RFC 5988.
  • The API ensures efficient data retrieval and navigation through dynamic parameter validation and calculation.
  • Be mindful of rate limits and data usage when making successive API calls.

Examples

First Request

  curl "https://runrun.it/api/v1.0/clients" -X GET \
    -H "App-Key: f9c650c98eeb28e345e0a38a184d20cb" \
    -H "User-Token: roBknmkPI0ALmwkRuC1q" \
    -H "Content-Type: application/json"

Response Headers

  Link: </api/clients>; rel="self", </api/clients?page=2>; rel="next", </api/clients?page=2>; rel="last"
  X-Item-Range: items 1-100/155

Requesting the next page

  curl "https://runrun.it/api/v1.0/clients?page=2" -X GET \
    -H "App-Key: f9c650c98eeb28e345e0a38a184d20cb" \
    -H "User-Token: roBknmkPI0ALmwkRuC1q" \
    -H "Content-Type: application/json"

Webhooks

Manage Webhooks

On the API and Webhooks page, you can manage all webhooks on your account. To create or update a webhook, click on the + button, then select the event you want to listen to and enter the URL that will receive the HTTP POST payload. After creating a webhook, click Save to persist your changes.

Webhook section

To delete a webhook, click on the trash icon button and then "Delete".

Supported events

  • task:create → Triggered when a task is created.
  • task:deliver → Triggered when a task is delivered, that is, moved from an open stage to a closed stage.
  • task:reopen → Triggered when a task is reopened, that is, when it is moved from a closed step to an open step.
  • task:move → Triggered when a task is moved between stages without changing its state (open/closed).
  • task:add_manual_work_period → Triggered when a user adds hours manually to a task.
  • task:remove_manual_work_period → Triggered when a user removes hours manually to a task.
  • task:change_time_worked → Triggered when the total time worked on a task changes.
  • task_assignment:play → Triggered when an assignee clicks on the play button.
  • task_assignment:pause → Triggered when an assignee clicks on the pause button.
  • project:create → Triggered when a project is created.
  • project:change_time_worked → Triggered when the total time worked on a project changes.
  • client:create → Triggered when a client is created.

Response

Here is an example of the HTTP POST payload:

  {
    "event": "task:deliver",
    "happened_at": "2020-01-21 19:49:02 -0300",
    "performer": { "id": "john-snow", "email": "john.snow@runrun.it" },
    "data": {
      "task": {
        "id": 3302,
        "board": { "id": 89 },
        "board_stage": { "id": 48 },
        "project": { "id": 66 },
        "assignees": [
          { "id": "petey-cruiser", "email": "petey.cruiser@runrun.it" },
          { "id": "anna-mull", "email": "anna.mull@runrun.it" }
        ],
        "user": { "id": "jack-doe", "email": "jack.doe@runrun.it" },
        "url": "https://runrun.it/pt-BR/tasks/3302"
      }
    }
  }

Contacting API Support

If you have any trouble using the API, you can email us at help@runrun.it.

BoardStages

GET

/api/v1.0/boards/:board_id/stages

List all board_stages

Request

Route

GET /api/v1.0/boards/1/stages

Headers

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

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

[
  {
    "id": 4,
    "name": "Board Stage 14",
    "stage_group": "opened",
    "board_id": 1,
    "position": 3,
    "is_following": false,
    "use_latency_time": true,
    "use_scrum_points": true,
    "is_default": false,
    "is_delivered": false,
    "status_group": "assigned"
  },
  {
    "id": 3,
    "name": "Stage Closed 1",
    "stage_group": "closed",
    "board_id": 1,
    "position": 1,
    "is_following": false,
    "use_latency_time": true,
    "use_scrum_points": true,
    "is_default": false,
    "is_delivered": false,
    "status_group": "done"
  },
  {
    "id": 2,
    "name": "Stage Opened 2",
    "stage_group": "opened",
    "board_id": 1,
    "position": 2,
    "is_following": false,
    "use_latency_time": true,
    "use_scrum_points": true,
    "is_default": false,
    "is_delivered": false,
    "status_group": "assigned"
  },
  {
    "id": 1,
    "name": "Stage Opened 1",
    "stage_group": "opened",
    "board_id": 1,
    "position": 1,
    "is_following": false,
    "use_latency_time": true,
    "use_scrum_points": true,
    "is_default": false,
    "is_delivered": false,
    "status_group": "assigned"
  }
]
GET

/api/v1.0/boards/:board_id/stages/:id

Show a BoardStage

Request

Route

GET /api/v1.0/boards/1/stages/4

Headers

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

cURL

curl "https://runrun.it/api/v1.0/boards/1/stages/4" -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 Board Stage integer
name Display name of Board Stage string
stage_group Group of stage ('opened' or 'closed') enum
board_id ID of Board integer
position Position of stage in Board integer
is_following Returns 'true' if user follows the Board Stage boolean
use_latency_time Returns 'true' if board stage latency time is being calculated boolean
use_scrum_points Returns 'true' if task points should be shown boolean
user_settings User settings for board stage hash

Status

200

Headers

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

Body

{
  "id": 4,
  "name": "Board Stage 15",
  "stage_group": "opened",
  "board_id": 1,
  "position": 3,
  "is_following": false,
  "use_latency_time": true,
  "use_scrum_points": true,
  "is_default": false,
  "is_delivered": false,
  "status_group": "assigned"
}
POST

/api/v1.0/boards/:board_id/stages

Create a board_stage

Parameters

Name Description type
board_stages[name] required

Display name of Board Stage

string

board_stages[stage_group] required

Group of stage ('opened' or 'closed')

enum

board_stages[board_id] required

ID of Board

integer

Request

Route

POST /api/v1.0/boards/1/stages

Headers

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

Body

{
  "board_stage": {
    "name": "Board Stage 16",
    "board_id": 1,
    "stage_group": "opened"
  }
}

cURL

curl "https://runrun.it/api/v1.0/boards/1/stages" -d '{"board_stage":{"name":"Board Stage 16","board_id":1,"stage_group":"opened"}}' -X POST \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

201

Headers

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

Body

{
  "id": 4,
  "name": "Board Stage 16",
  "stage_group": "opened",
  "board_id": 1,
  "position": 3,
  "is_following": false,
  "use_latency_time": true,
  "use_scrum_points": true,
  "is_default": false,
  "is_delivered": false,
  "status_group": "assigned"
}
PUT

/api/v1.0/boards/:board_id/stages/:id

Update a board_stage

Parameters

Name Description type
board_stages[name] required

Display name of Board Stage

string

Request

Route

PUT /api/v1.0/boards/1/stages/4

Headers

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

Body

{
  "board_stage": {
    "name": "New Board"
  }
}

cURL

curl "https://runrun.it/api/v1.0/boards/1/stages/4" -d '{"board_stage":{"name":"New Board"}}' -X PUT \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": 4,
  "name": "New Board",
  "stage_group": "opened",
  "board_id": 1,
  "position": 3,
  "is_following": false,
  "use_latency_time": true,
  "use_scrum_points": true,
  "is_default": false,
  "is_delivered": false,
  "status_group": "assigned"
}
DELETE

/api/v1.0/boards/:board_id/stages/:id

Destroy a board_stage

Request

Route

DELETE /api/v1.0/boards/1/stages/4

Headers

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

cURL

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

Response

Simulated Response

Status

200

Headers

Content-Type: application/json
Content-Length: 0
POST

/api/v1.0/boards/:board_id/stages/:id/move

Move a board stage

Parameters

Name Description type
board_stages[board_id] required

ID of Board

integer

board_stages[id]

ID of Board Stage

integer

board_stages[position] required

Position of stage in Board

integer

Request

Route

POST /api/v1.0/boards/1/stages/4/move

Headers

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

Body

{
  "position": 2
}

cURL

curl "https://runrun.it/api/v1.0/boards/1/stages/4/move" -d '{"position":2}' -X POST \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": 4,
  "name": "Board Stage 20",
  "stage_group": "opened",
  "board_id": 1,
  "position": 2,
  "is_following": false,
  "use_latency_time": true,
  "use_scrum_points": true,
  "is_default": false,
  "is_delivered": false,
  "status_group": "assigned"
}

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://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

200

Headers

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

Body

[
  {
    "id": 1,
    "description": "Paper clips",
    "position": null,
    "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://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

201

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://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

200

Headers

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

Body

{
  "id": 1,
  "description": "Paper clips",
  "position": null,
  "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://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

200

Headers

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

Body

{
  "id": 1,
  "description": "Buy beer",
  "position": null,
  "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://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

204

Headers

Checklists

GET

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

Show a checklist from a task

Request

Route

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

Headers

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

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

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

  ]
}
PUT

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

Update a checklist from a task

Request

Route

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

Headers

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

Body

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

cURL

curl "https://runrun.it/api/v1.0/tasks/1/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

200

Headers

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

Body

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

  ]
}
DELETE

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

Destroy a checklist from a task

Request

Route

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

Headers

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

cURL

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

Response

Simulated Response

Status

204

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://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

200

Headers

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

Body

{
  "id": 1,
  "title": "Office Supplies Template",
  "creator_id": "coyote-42",
  "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://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

200

Headers

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

Body

{
  "id": 1,
  "title": "Kitchen supplies",
  "creator_id": "coyote-46",
  "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://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

204

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://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

200

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://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
custom_field Custom field string
is_visible Client is currently visible to be used boolean
budgeted_hours_month Budgeted hours per month decimal
budgeted_cost_month Budgeted cost per month decimal
projects_count Number of projects in the client integer
time_worked Time (in seconds) worked in the client integer
time_pending_not_assigned Time (in seconds) pending not assigned in the client integer
time_pending_queued Time (in seconds) pending queued in the client integer
time_pending Time (in seconds) pending in the client integer
time_total Total seconds spent in the client integer
time_progress Progress of time worked on the client float
cost_worked Cost spent on the client float
cost_pending Cost pending in the client float
cost_total Total cost of the client float
activities_6_days_ago Time (in seconds) worked in the client 6 days ago integer
activities_5_days_ago Time (in seconds) worked in the client 5 days ago integer
activities_4_days_ago Time (in seconds) worked in the client 4 days ago integer
activities_3_days_ago Time (in seconds) worked in the client 3 days ago integer
activities_2_days_ago Time (in seconds) worked in the client 2 days ago integer
activities_1_days_ago Time (in seconds) worked in the client 1 days ago integer
activities_0_days_ago Time (in seconds) worked in the client today integer
activities Total time (in seconds) worked today and in the last 6 days integer
time_pending_backlog [Deprecated] Use time_pending_not_assigned integer
project_groups [Deprecated] Project groups array

Status

200

Headers

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

Body

{
  "id": 1,
  "name": "Test client 31",
  "custom_field": null,
  "is_visible": true,
  "budgeted_hours_month": 0,
  "budgeted_cost_month": 0.0,
  "projects_count": 0,
  "time_worked": 0,
  "time_pending_not_assigned": 0,
  "time_pending_queued": 0,
  "time_pending": 0,
  "time_total": 0,
  "time_progress": 0.0,
  "cost_worked": 0.0,
  "cost_pending": 0.0,
  "cost_total": 0.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_days_ago": 0,
  "activities": 0,
  "time_pending_backlog": 0,
  "project_groups": [
    {
      "id": 1,
      "name": null,
      "client_id": 1,
      "is_default": true,
      "created_at": "2022-02-23T09:57:55-03:00",
      "updated_at": "2022-02-23T09:57:55-03:00"
    }
  ],
  "project_ids": [

  ]
}
POST

/api/v1.0/clients/export

Export

Request

Route

POST /api/v1.0/clients/export

Headers

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

Body

{
  "format_type": "xlsx"
}

cURL

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

Response

Simulated Response

Status

200

Headers

Content-Type: application/json
Content-Length: 0

Request

Route

POST /api/v1.0/clients/export

Headers

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

Body

{
  "format_type": "csv"
}

cURL

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

Response

Simulated Response

Status

200

Headers

Content-Type: application/json
Content-Length: 0

Request

Route

POST /api/v1.0/clients/export

Headers

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

Body

{
  "format_type": "bad_format"
}

cURL

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

Response

Simulated Response

Status

400

Headers

Content-Type: application/json
Content-Length: 0
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": {
    "name": "Test client 32",
    "is_visible": true,
    "budgeted_hours_month": 0,
    "budgeted_cost_month": "0.0"
  }
}

cURL

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

Response

Simulated Response

Status

201

Headers

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

Body

{
  "id": 1,
  "name": "Test client 32",
  "custom_field": null,
  "is_visible": true,
  "budgeted_hours_month": 0,
  "budgeted_cost_month": 0.0,
  "projects_count": 0,
  "time_worked": 0,
  "time_pending_not_assigned": 0,
  "time_pending_queued": 0,
  "time_pending": 0,
  "time_total": 0,
  "time_progress": 0.0,
  "cost_worked": 0.0,
  "cost_pending": 0.0,
  "cost_total": 0.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_days_ago": 0,
  "activities": 0,
  "time_pending_backlog": 0,
  "project_groups": [
    {
      "id": 1,
      "name": null,
      "client_id": 1,
      "is_default": true,
      "created_at": "2022-02-23T09:57:58-03:00",
      "updated_at": "2022-02-23T09:57:58-03:00"
    }
  ],
  "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://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

200

Headers

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

Body

{
  "id": 1,
  "name": "Widgets Inc",
  "custom_field": null,
  "is_visible": true,
  "budgeted_hours_month": 0,
  "budgeted_cost_month": 0.0,
  "projects_count": 0,
  "time_worked": 0,
  "time_pending_not_assigned": 0,
  "time_pending_queued": 0,
  "time_pending": 0,
  "time_total": 0,
  "time_progress": 0.0,
  "cost_worked": 0.0,
  "cost_pending": 0.0,
  "cost_total": 0.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_days_ago": 0,
  "activities": 0,
  "time_pending_backlog": 0,
  "project_groups": [
    {
      "id": 1,
      "name": null,
      "client_id": 1,
      "is_default": true,
      "created_at": "2022-02-23T09:57:59-03:00",
      "updated_at": "2022-02-23T09:57:59-03:00"
    }
  ],
  "project_ids": [

  ]
}

Comments

GET

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

List comments on a task

Request

Route

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

Headers

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

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

[
  {
    "id": 2,
    "user_id": null,
    "guest_id": null,
    "is_system_message": true,
    "text": "System text",
    "commenter_name": null,
    "children_count": 0,
    "commentable_id": 1,
    "commentable_type": "Task",
    "created_at": "2022-02-23T09:58:10-03:00",
    "edited_at": null,
    "deleted_at": null,
    "thread_id": 2,
    "quoted_comment_id": null,
    "quoted_comment_text": null,
    "quoted_comment_user_id": null,
    "quoted_comment_user_name": null,
    "quoted_comment_guest_id": null,
    "quoted_comment_guest_name": null,
    "task_id": 1,
    "comment_id": null,
    "team_id": null,
    "enterprise_id": null,
    "document_id": null,
    "is_legacy": false,
    "media": null,
    "documents": [

    ],
    "reactions": [

    ]
  },
  {
    "id": 1,
    "user_id": "coyote-142",
    "guest_id": null,
    "is_system_message": false,
    "text": "Comment text",
    "commenter_name": "Coyote 142",
    "children_count": 0,
    "commentable_id": 1,
    "commentable_type": "Task",
    "created_at": "2022-02-23T09:58:10-03:00",
    "edited_at": null,
    "deleted_at": null,
    "thread_id": 1,
    "quoted_comment_id": null,
    "quoted_comment_text": null,
    "quoted_comment_user_id": null,
    "quoted_comment_user_name": null,
    "quoted_comment_guest_id": null,
    "quoted_comment_guest_name": null,
    "task_id": 1,
    "comment_id": null,
    "team_id": null,
    "enterprise_id": null,
    "document_id": null,
    "is_legacy": false,
    "media": null,
    "documents": [

    ],
    "reactions": [

    ]
  }
]
GET

/api/v1.0/comments/:id

Show a specific comment

Request

Route

GET /api/v1.0/comments/1

Headers

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

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": 1,
  "user_id": "coyote-147",
  "guest_id": null,
  "is_system_message": false,
  "text": "Comment text",
  "commenter_name": "Coyote 147",
  "children_count": 0,
  "commentable_id": 1,
  "commentable_type": "Task",
  "created_at": "2022-02-23T09:58:19-03:00",
  "edited_at": null,
  "deleted_at": null,
  "thread_id": 1,
  "quoted_comment_id": null,
  "quoted_comment_text": null,
  "quoted_comment_user_id": null,
  "quoted_comment_user_name": null,
  "quoted_comment_guest_id": null,
  "quoted_comment_guest_name": null,
  "task_id": 1,
  "comment_id": null,
  "team_id": null,
  "enterprise_id": null,
  "document_id": null,
  "is_legacy": false,
  "media": null,
  "documents": [

  ],
  "reactions": [

  ]
}
POST

/api/v1.0/comments

Create a new comment

Request

Route

POST /api/v1.0/comments

Headers

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

Body

{
  "task_id": 1,
  "text": "Comment text"
}

cURL

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

Response

Simulated Response

Status

201

Headers

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

Body

{
  "id": 1,
  "user_id": "coyote-149",
  "guest_id": null,
  "is_system_message": false,
  "text": "Comment text",
  "commenter_name": "Coyote 149",
  "children_count": 0,
  "commentable_id": 1,
  "commentable_type": "Task",
  "created_at": "2022-02-23T09:58:22-03:00",
  "edited_at": null,
  "deleted_at": null,
  "thread_id": 1,
  "quoted_comment_id": null,
  "quoted_comment_text": null,
  "quoted_comment_user_id": null,
  "quoted_comment_user_name": null,
  "quoted_comment_guest_id": null,
  "quoted_comment_guest_name": null,
  "task_id": 1,
  "comment_id": null,
  "team_id": null,
  "enterprise_id": null,
  "document_id": null,
  "is_legacy": false,
  "media": null,
  "documents": [

  ],
  "reactions": [

  ]
}
POST

/api/v1.0/comments

Create a new comment

Request

Route

POST /api/v1.0/comments

Headers

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

Body

{
  "task_id": 1,
  "text": "Comment text"
}

cURL

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

Response

Simulated Response

Status

201

Headers

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

Body

{
  "id": 1,
  "user_id": "coyote-149",
  "guest_id": null,
  "is_system_message": false,
  "text": "Comment text",
  "commenter_name": "Coyote 149",
  "children_count": 0,
  "commentable_id": 1,
  "commentable_type": "Task",
  "created_at": "2022-02-23T09:58:22-03:00",
  "edited_at": null,
  "deleted_at": null,
  "thread_id": 1,
  "quoted_comment_id": null,
  "quoted_comment_text": null,
  "quoted_comment_user_id": null,
  "quoted_comment_user_name": null,
  "quoted_comment_guest_id": null,
  "quoted_comment_guest_name": null,
  "task_id": 1,
  "comment_id": null,
  "team_id": null,
  "enterprise_id": null,
  "document_id": null,
  "is_legacy": false,
  "media": null,
  "documents": [

  ],
  "reactions": [

  ]
}
POST

/api/v1.0/comments

Create a new project comment

Request

Route

POST /api/v1.0/comments

Headers

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

Body

{
  "project_id": 1,
  "text": "comment"
}

cURL

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

Response

Simulated Response

Status

201

Headers

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

Body

{
  "id": 1,
  "user_id": "coyote-152",
  "guest_id": null,
  "is_system_message": false,
  "text": "comment",
  "commenter_name": "Coyote 152",
  "children_count": 0,
  "commentable_id": null,
  "commentable_type": "Project",
  "created_at": "2022-02-23T09:58:27-03:00",
  "edited_at": null,
  "deleted_at": null,
  "thread_id": 1,
  "quoted_comment_id": null,
  "quoted_comment_text": null,
  "quoted_comment_user_id": null,
  "quoted_comment_user_name": null,
  "quoted_comment_guest_id": null,
  "quoted_comment_guest_name": null,
  "task_id": null,
  "comment_id": null,
  "team_id": null,
  "enterprise_id": null,
  "document_id": null,
  "is_legacy": false,
  "media": null,
  "documents": [

  ],
  "reactions": [

  ]
}
PUT

/api/v1.0/comments/:id

Update a comment

Request

Route

PUT /api/v1.0/comments/1

Headers

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

Body

{
  "text": "New text"
}

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": 1,
  "user_id": "coyote-153",
  "guest_id": null,
  "is_system_message": false,
  "text": "New text",
  "commenter_name": "Coyote 153",
  "children_count": 0,
  "commentable_id": 1,
  "commentable_type": "Task",
  "created_at": "2022-02-23T09:58:28-03:00",
  "edited_at": "2022-02-23T09:58:28-03:00",
  "deleted_at": null,
  "thread_id": 1,
  "quoted_comment_id": null,
  "quoted_comment_text": null,
  "quoted_comment_user_id": null,
  "quoted_comment_user_name": null,
  "quoted_comment_guest_id": null,
  "quoted_comment_guest_name": null,
  "task_id": 1,
  "comment_id": null,
  "team_id": null,
  "enterprise_id": null,
  "document_id": null,
  "is_legacy": false,
  "media": null,
  "documents": [

  ],
  "reactions": [

  ]
}
DELETE

/api/v1.0/comments/:id

Destroy a comment

Request

Route

DELETE /api/v1.0/comments/1

Headers

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

cURL

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

Response

Simulated Response

Status

204

Headers

POST

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

Reaction to a comment

Request

Route

POST /api/v1.0/comments/1/reaction

Headers

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

Body

{
  "emoji": "👨"
}

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": 1,
  "user_id": "coyote-157",
  "guest_id": null,
  "is_system_message": false,
  "text": "Comment text",
  "commenter_name": "Coyote 157",
  "children_count": 0,
  "commentable_id": 1,
  "commentable_type": "Task",
  "created_at": "2022-02-23T09:58:35-03:00",
  "edited_at": null,
  "deleted_at": null,
  "thread_id": 1,
  "quoted_comment_id": null,
  "quoted_comment_text": null,
  "quoted_comment_user_id": null,
  "quoted_comment_user_name": null,
  "quoted_comment_guest_id": null,
  "quoted_comment_guest_name": null,
  "task_id": 1,
  "comment_id": null,
  "team_id": null,
  "enterprise_id": null,
  "document_id": null,
  "is_legacy": false,
  "media": null,
  "documents": [

  ],
  "reactions": [
    {
      "emoji": "👨",
      "count": 1,
      "users": [
        {
          "slug": "coyote-157",
          "name": "Coyote 157"
        }
      ]
    }
  ]
}

DashboardWidgets

GET

/api/v1.0/dashboards/:dashboard_id/dashboard_widgets

List all widgets for the current dashboard

List all widgets for the current dashboard

Request

Route

GET /api/v1.0/dashboards/1/dashboard_widgets

Headers

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

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

[
  {
    "id": 1,
    "dashboard_id": 1,
    "name": "Widget 1",
    "kind": "project_indicator",
    "user_id": "coyote-125",
    "valid": true,
    "aggregation": {
    },
    "restriction": [

    ],
    "conditions": [

    ],
    "grouping": [

    ],
    "sorting": [

    ],
    "parameters": {
    },
    "refreshed_at": null,
    "grid_x": 1,
    "grid_y": 1,
    "grid_w": 1,
    "grid_h": 1,
    "data_url": "http://example.org/api/projects?dashboard_widget_id=1",
    "data_expanded_url": "/company/projects?dashboard_widget_id=1&expand=true",
    "data_export_url": "http://example.org/api/projects/export?dashboard_widget_id=1&expand=true"
  }
]
GET

/api/v1.0/dashboard_widgets/:id

List a choosen widget for the current dashboard

List a choosen widget for the current dashboard

Request

Route

GET /api/v1.0/dashboard_widgets/1

Headers

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

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": 1,
  "dashboard_id": 1,
  "name": "Widget 2",
  "kind": "project_indicator",
  "user_id": "coyote-126",
  "valid": true,
  "aggregation": {
  },
  "restriction": [

  ],
  "conditions": [

  ],
  "grouping": [

  ],
  "sorting": [

  ],
  "parameters": {
  },
  "refreshed_at": null,
  "grid_x": 2,
  "grid_y": 2,
  "grid_w": 1,
  "grid_h": 1,
  "data_url": "/api/projects?dashboard_widget_id=1",
  "data_expanded_url": "/company/projects?dashboard_widget_id=1&expand=true",
  "data_export_url": "/api/projects/export?dashboard_widget_id=1&expand=true"
}
GET

/api/v1.0/dashboard_widgets/:id

List a choosen widget for the current dashboard with the report's url

List a choosen widget for the current dashboard with the report's url

Request

Route

GET /api/v1.0/dashboard_widgets/1

Headers

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

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": 1,
  "dashboard_id": 1,
  "name": "Widget 3",
  "kind": "task_indicator",
  "user_id": "coyote-160",
  "valid": true,
  "aggregation": {
  },
  "restriction": [

  ],
  "conditions": [

  ],
  "grouping": [

  ],
  "sorting": [

  ],
  "parameters": {
  },
  "refreshed_at": null,
  "grid_x": 3,
  "grid_y": 3,
  "grid_w": 1,
  "grid_h": 1,
  "data_url": "/api/tasks?bypass_status_default=true&dashboard_widget_id=1&include_not_assigned=true",
  "data_expanded_url": "/pt-BR/company/tasks?dashboard_widget_id=1&expand=true",
  "data_export_url": "/api/tasks/export?bypass_status_default=true&dashboard_widget_id=1&expand=true&include_not_assigned=true"
}
POST

/api/v1.0/dashboards/:dashboard_id/dashboard_widgets

Create a widget

Create a new widget for the given dashboard

Request

Route

POST /api/v1.0/dashboards/1/dashboard_widgets

Headers

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

Body

{
  "widget": {
    "name": "New Widget",
    "kind": "project_indicator",
    "grid_x": 1,
    "grid_y": 1,
    "grid_w": 1,
    "grid_h": 1
  }
}

cURL

curl "https://runrun.it/api/v1.0/dashboards/1/dashboard_widgets" -d '{"widget":{"name":"New Widget","kind":"project_indicator","grid_x":1,"grid_y":1,"grid_w":1,"grid_h":1}}' -X POST \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

201

Headers

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

Body

{
  "id": 2,
  "dashboard_id": 1,
  "name": "New Widget",
  "kind": "project_indicator",
  "user_id": "coyote-128",
  "valid": true,
  "aggregation": {
  },
  "restriction": [

  ],
  "conditions": [

  ],
  "grouping": [

  ],
  "sorting": [

  ],
  "parameters": {
  },
  "refreshed_at": null,
  "grid_x": 1,
  "grid_y": 1,
  "grid_w": 1,
  "grid_h": 1,
  "data_url": "/api/projects?dashboard_widget_id=2",
  "data_expanded_url": "/company/projects?dashboard_widget_id=2&expand=true",
  "data_export_url": "/api/projects/export?dashboard_widget_id=2&expand=true"
}
PUT

/api/v1.0/dashboard_widgets/:id

Update a dashboard

Update a dashboard for the current_user

Request

Route

PUT /api/v1.0/dashboard_widgets/1

Headers

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

Body

{
  "widget": {
    "name": "New Widget",
    "kind": "project_indicator",
    "grid_x": 1,
    "grid_y": 1,
    "grid_w": 1,
    "grid_h": 1
  }
}

cURL

curl "https://runrun.it/api/v1.0/dashboard_widgets/1" -d '{"widget":{"name":"New Widget","kind":"project_indicator","grid_x":1,"grid_y":1,"grid_w":1,"grid_h":1}}' -X PUT \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": 1,
  "dashboard_id": 1,
  "name": "New Widget",
  "kind": "project_indicator",
  "user_id": "coyote-129",
  "valid": true,
  "aggregation": {
  },
  "restriction": [

  ],
  "conditions": [

  ],
  "grouping": [

  ],
  "sorting": [

  ],
  "parameters": {
  },
  "refreshed_at": null,
  "grid_x": 5,
  "grid_y": 5,
  "grid_w": 1,
  "grid_h": 1,
  "data_url": "/api/projects?dashboard_widget_id=1",
  "data_expanded_url": "/company/projects?dashboard_widget_id=1&expand=true",
  "data_export_url": "/api/projects/export?dashboard_widget_id=1&expand=true"
}
DELETE

/api/v1.0/dashboard_widgets/:id

Destroy a widget

Delete a selected widget

Request

Route

DELETE /api/v1.0/dashboard_widgets/1

Headers

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

cURL

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

Response

Simulated Response

Status

204

Headers

PUT

/api/v1.0/dashboards/:dashboard_id/dashboard_widgets/reorder

Reorder all widgets for the selected dashboard

Reorder all widgets for the selected dashboard

Request

Route

PUT /api/v1.0/dashboards/1/dashboard_widgets/reorder

Headers

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

Body

{
  "dashboard_widgets": [
    {
      "id": 1,
      "dashboard_id": 1,
      "widget_id": 1,
      "grid_x": 3,
      "grid_y": 1,
      "grid_w": 1,
      "grid_h": 1,
      "created_at": "2022-02-23T09:58:44-03:00",
      "updated_at": "2022-02-23T09:58:44-03:00"
    },
    {
      "id": 2,
      "dashboard_id": 1,
      "widget_id": 2,
      "grid_x": 2,
      "grid_y": 1,
      "grid_w": 1,
      "grid_h": 1,
      "created_at": "2022-02-23T09:58:44-03:00",
      "updated_at": "2022-02-23T09:58:44-03:00"
    },
    {
      "id": 3,
      "dashboard_id": 1,
      "widget_id": 3,
      "grid_x": 1,
      "grid_y": 1,
      "grid_w": 1,
      "grid_h": 1,
      "created_at": "2022-02-23T09:58:44-03:00",
      "updated_at": "2022-02-23T09:58:44-03:00"
    }
  ]
}

cURL

curl "https://runrun.it/api/v1.0/dashboards/1/dashboard_widgets/reorder" -d '{"dashboard_widgets":[{"id":1,"dashboard_id":1,"widget_id":1,"grid_x":3,"grid_y":1,"grid_w":1,"grid_h":1,"created_at":"2022-02-23T09:58:44-03:00","updated_at":"2022-02-23T09:58:44-03:00"},{"id":2,"dashboard_id":1,"widget_id":2,"grid_x":2,"grid_y":1,"grid_w":1,"grid_h":1,"created_at":"2022-02-23T09:58:44-03:00","updated_at":"2022-02-23T09:58:44-03:00"},{"id":3,"dashboard_id":1,"widget_id":3,"grid_x":1,"grid_y":1,"grid_w":1,"grid_h":1,"created_at":"2022-02-23T09:58:44-03:00","updated_at":"2022-02-23T09:58:44-03:00"}]}' -X PUT \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

200

Headers

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

Body

[
  {
    "id": 1,
    "dashboard_id": 1,
    "name": "Widget 7",
    "kind": "project_indicator",
    "user_id": "coyote-164",
    "valid": true,
    "aggregation": {
    },
    "restriction": [

    ],
    "conditions": [

    ],
    "grouping": [

    ],
    "sorting": [

    ],
    "parameters": {
    },
    "refreshed_at": null,
    "grid_x": 3,
    "grid_y": 1,
    "grid_w": 1,
    "grid_h": 1,
    "data_url": "/api/projects?dashboard_widget_id=1",
    "data_expanded_url": "/pt-BR/company/projects?dashboard_widget_id=1&expand=true",
    "data_export_url": "/api/projects/export?dashboard_widget_id=1&expand=true"
  },
  {
    "id": 2,
    "dashboard_id": 1,
    "name": "Widget 8",
    "kind": "project_indicator",
    "user_id": "coyote-164",
    "valid": true,
    "aggregation": {
    },
    "restriction": [

    ],
    "conditions": [

    ],
    "grouping": [

    ],
    "sorting": [

    ],
    "parameters": {
    },
    "refreshed_at": null,
    "grid_x": 2,
    "grid_y": 1,
    "grid_w": 1,
    "grid_h": 1,
    "data_url": "/api/projects?dashboard_widget_id=2",
    "data_expanded_url": "/pt-BR/company/projects?dashboard_widget_id=2&expand=true",
    "data_export_url": "/api/projects/export?dashboard_widget_id=2&expand=true"
  },
  {
    "id": 3,
    "dashboard_id": 1,
    "name": "Widget 9",
    "kind": "project_indicator",
    "user_id": "coyote-164",
    "valid": true,
    "aggregation": {
    },
    "restriction": [

    ],
    "conditions": [

    ],
    "grouping": [

    ],
    "sorting": [

    ],
    "parameters": {
    },
    "refreshed_at": null,
    "grid_x": 1,
    "grid_y": 1,
    "grid_w": 1,
    "grid_h": 1,
    "data_url": "/api/projects?dashboard_widget_id=3",
    "data_expanded_url": "/pt-BR/company/projects?dashboard_widget_id=3&expand=true",
    "data_export_url": "/api/projects/export?dashboard_widget_id=3&expand=true"
  }
]

Dashboards

GET

/api/v1.0/dashboards

List all dashboards for the current_user

List all dashboards for the active user

Request

Route

GET /api/v1.0/dashboards

Headers

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

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

[
  {
    "id": 1,
    "name": "Dashboard 8",
    "user_id": "coyote-132"
  }
]
GET

/api/v1.0/dashboards/:id

List a choosen dashboard for the current_user

List a choosen dashboard for the active user

Request

Route

GET /api/v1.0/dashboards/1

Headers

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

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": 1,
  "name": "Dashboard 9",
  "user_id": "coyote-133"
}
POST

/api/v1.0/dashboards

Create a dashboard

Create a new dashboard for the current_user

Request

Route

POST /api/v1.0/dashboards

Headers

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

Body

{
  "dashboard": {
    "name": "New Dashboard"
  }
}

cURL

curl "https://runrun.it/api/v1.0/dashboards" -d '{"dashboard":{"name":"New Dashboard"}}' -X POST \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

201

Headers

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

Body

{
  "id": 2,
  "name": "New Dashboard",
  "user_id": "coyote-135"
}
PUT

/api/v1.0/dashboards/:id

Update a dashboard

Update a dashboard for the current_user

Request

Route

PUT /api/v1.0/dashboards/1

Headers

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

Body

{
  "dashboard": {
    "name": "Another Dashboard"
  }
}

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": 1,
  "name": "Another Dashboard",
  "user_id": "coyote-136"
}
DELETE

/api/v1.0/dashboards/:id

Destroy a dashboard

Delete a selected dashboard

Request

Route

DELETE /api/v1.0/dashboards/1

Headers

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

cURL

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

Response

Simulated Response

Status

501

Headers

Content-Type: application/json
Content-Length: 0

Demanders

GET

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

List all demanders of user

Return a list of all demanders of user. Demanders 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-174/demanders

Headers

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

cURL

curl "https://runrun.it/api/v1.0/users/coyote-174/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
cost_hour Current user cost per hour decimal
is_master User is an administrator boolean
is_manager User is a manager boolean
is_auditor User is an auditor boolean
can_create_client_project_and_task_types User has permission to create client, projects and task types boolean
can_create_boards User has permission to create boards boolean
is_blocked_on_mobile User has mobile apps access blocked boolean
bypass_block_by_time_worked User ignore the blocking rule for time worked 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
created_at User creation date datetime
in_company_since Joining date in company date
is_certified Whether the user has passed Runrun.it certification boolean
language User preference language string
alt_id Constant size ID (internal use only) string
oid Constant size ID (internal use only) string
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
blocked_by_time_worked_at When the user is blocked for being out of the acceptable worked time defined by the company datetime
demanders_count Demanders count integer
partners_count Partners count integer
has_all_users_as_partners True if user has all users as partners boolean
has_all_users_as_demanders True if has all users as demanders boolean
password_updated_at Last time user password was updated datetime
password_expired_at Time when the user password was considered expired datetime
shift_work_time_per_week Shift work time (in seconds) per week integer
team_ids Ids from teams that the user belongs to array
led_team_ids Ids from teams the user leads array
skip_time_adjust_on_task_assignment_deliver User preference of skip adjust time modal on task deliver boolean
theme User preference of theme for interface between light or dark mode string
task_list_background_image_url Image url for background of task list string

Status

200

Headers

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

Body

[
  {
    "id": "coyote-175",
    "name": "Coyote 175",
    "email": "coyote175@acme.foo",
    "avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-141/coyote-175/mini.png",
    "avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-141/coyote-175/regular.png",
    "cost_hour": 0.0,
    "is_master": false,
    "is_manager": false,
    "is_auditor": false,
    "can_create_client_project_and_task_types": false,
    "can_create_boards": true,
    "is_blocked_on_mobile": false,
    "bypass_block_by_time_worked": false,
    "time_zone": "America/Sao_Paulo",
    "position": null,
    "on_vacation": false,
    "birthday": null,
    "phone": null,
    "gender": null,
    "marital_status": null,
    "created_at": "2022-02-23T09:58:55-03:00",
    "in_company_since": null,
    "is_certified": false,
    "language": "pt-BR",
    "alt_id": "1d571b8722326d915d71cfab6d4c1743",
    "oid": "dbfa7092b",
    "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",
        "work_time": 0
      },
      {
        "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",
        "work_time": 28800
      },
      {
        "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",
        "work_time": 28800
      },
      {
        "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",
        "work_time": 28800
      },
      {
        "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",
        "work_time": 28800
      },
      {
        "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",
        "work_time": 28800
      },
      {
        "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",
        "work_time": 0
      }
    ],
    "is_mensurable": true,
    "time_tracking_mode": "smart",
    "blocked_by_time_worked_at": null,
    "demanders_count": 0,
    "partners_count": 0,
    "has_all_users_as_partners": false,
    "has_all_users_as_demanders": false,
    "password_updated_at": null,
    "password_expired_at": null,
    "shift_work_time_per_week": 144000,
    "team_ids": [

    ],
    "led_team_ids": [

    ],
    "skip_time_adjust_on_task_assignment_deliver": false,
    "theme": "light",
    "task_list_background_image_url": null
  },
  {
    "id": "coyote-174",
    "name": "Coyote 174",
    "email": "coyote174@acme.foo",
    "avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-141/coyote-174/mini.png",
    "avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-141/coyote-174/regular.png",
    "cost_hour": 0.0,
    "is_master": false,
    "is_manager": false,
    "is_auditor": false,
    "can_create_client_project_and_task_types": false,
    "can_create_boards": true,
    "is_blocked_on_mobile": false,
    "bypass_block_by_time_worked": false,
    "time_zone": "America/Sao_Paulo",
    "position": null,
    "on_vacation": false,
    "birthday": null,
    "phone": null,
    "gender": null,
    "marital_status": null,
    "created_at": "2022-02-23T09:58:55-03:00",
    "in_company_since": null,
    "is_certified": false,
    "language": "pt-BR",
    "alt_id": "a4174451a16a06837277872582ceb125",
    "oid": "92a6f5b72",
    "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",
        "work_time": 0
      },
      {
        "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",
        "work_time": 28800
      },
      {
        "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",
        "work_time": 28800
      },
      {
        "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",
        "work_time": 28800
      },
      {
        "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",
        "work_time": 28800
      },
      {
        "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",
        "work_time": 28800
      },
      {
        "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",
        "work_time": 0
      }
    ],
    "is_mensurable": true,
    "time_tracking_mode": "smart",
    "blocked_by_time_worked_at": null,
    "demanders_count": 0,
    "partners_count": 0,
    "has_all_users_as_partners": false,
    "has_all_users_as_demanders": false,
    "password_updated_at": null,
    "password_expired_at": null,
    "shift_work_time_per_week": 144000,
    "team_ids": [

    ],
    "led_team_ids": [

    ],
    "skip_time_adjust_on_task_assignment_deliver": false,
    "theme": "light",
    "task_list_background_image_url": null
  }
]
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-177/demanders

Headers

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

Body

{
  "demander_id": "coyote-179"
}

cURL

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

Response

Simulated Response

Status

201

Headers

Content-Type: application/json
Content-Length: 0
POST

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

Replace a user partners list

Parameters

Name Description type
user_id required

User's ID

string

Request

Route

POST /api/v1.0/users/coyote-181/demanders/replace

Headers

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

Body

{
  "ids": "coyote-183,coyote-184"
}

cURL

curl "https://runrun.it/api/v1.0/users/coyote-181/demanders/replace" -d '{"ids":"coyote-183,coyote-184"}' -X POST \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

200

Headers

Content-Type: application/json
Content-Length: 0
DELETE

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

Destroy a demander of a user

Parameters

Name Description type
user_id required

User's ID

string

Request

Route

DELETE /api/v1.0/users/coyote-152/demanders/coyote-151

Headers

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

cURL

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

Response

Simulated Response

Status

204

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://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

200

Headers

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

Body

[
  {
    "project_id": 1,
    "description": "Cool Project",
    "current_editor_id": null,
    "current_editor_name": null,
    "edited_at": "2022-02-23T09:59:11-03:00",
    "locked_at": null
  },
  {
    "project_id": 2,
    "description": "Expensive Project",
    "current_editor_id": null,
    "current_editor_name": null,
    "edited_at": "2022-02-23T09:59:11-03:00",
    "locked_at": null
  }
]
GET

/api/v1.0/descriptions

Query Task Status 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?task_status_ids=3%2C4

Headers

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

Query Parameters

task_status_ids=3,4

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

[
  {
    "task_status_id": 3,
    "description": "Awesome Task Status"
  },
  {
    "task_status_id": 4,
    "description": "Another awesome Task Status"
  }
]
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://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

200

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://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

200

Headers

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

Body

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

/api/v1.0/descriptions

Query Single Task Status 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_status_id=3

Headers

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

Query Parameters

task_status_id=3

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "task_status_id": 3,
  "description": "Awesome Task Status"
}
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://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

200

Headers

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

Body

{
  "project_id": 1,
  "description": "Another Awesome Project Description",
  "current_editor_id": null,
  "current_editor_name": null,
  "edited_at": "2022-02-23T09:59:24-03:00",
  "locked_at": null
}
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": 13,
    "description": "Another Awesome Project Description"
  }
}

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "task_template_id": 13,
  "description": "Another Awesome Project Description",
  "current_editor_id": null,
  "current_editor_name": null,
  "edited_at": "2022-02-23T09:59:26-03:00",
  "locked_at": null
}
PUT

/api/v1.0/descriptions

Update Task Status 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_status_id": 3,
    "description": "Cool Task Status Description"
  }
}

cURL

curl "https://runrun.it/api/v1.0/descriptions" -d '{"description":{"task_status_id":3,"description":"Cool Task Status Description"}}' -X PUT \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

200

Headers

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

Body

{
  "task_status_id": 3,
  "description": "Cool Task Status 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/1/documents

Headers

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

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

[
  {
    "id": 1,
    "type": "UploadedDocument",
    "data_file_name": "awesome_report_6.txt",
    "data_file_size": 10,
    "data_content_type": "text/plain",
    "data_updated_at": "2022-02-23T09:59:29-03:00",
    "file_name": "awesome_report_6.txt",
    "file_size": 10,
    "file_content_type": "text/plain",
    "file_extension": "txt",
    "uploaded_at": "2022-02-23T09:59:29-03:00",
    "transfered": true,
    "uploader_id": "coyote-215",
    "uploader_name": "Coyote 215",
    "attachable_id": 1,
    "attachable_type": "Task",
    "attachable_name": "Bla",
    "thumbnail_file_name": null,
    "preview_file_name": null,
    "is_shared": false,
    "remote_id": null,
    "remote_icon_url": null,
    "evaluations": [

    ]
  }
]
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://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
type Subclass of Document string
data_file_name [Deprecated] use file_name string
data_file_size [Deprecated] use file_size integer
data_content_type [Deprecated] use file_content_type string
data_updated_at [Deprecated] use uploaded_at datetime
file_name Name of the document string
file_size Size in bytes integer
file_content_type MIME type of file string
file_extension Document's extension string
uploaded_at Datetime when file was uploaded datetime
transfered Whether the file has be successfully uploaded to the cloud boolean
uploader_id ID of the user who uploaded the file string
uploader_name Name of the user who uploaded the file string
attachable_id To which resource id this document belongs to string
attachable_type To which resource type this document belongs to string
attachable_name Name of the attachable string
thumbnail_file_name Name of the thumbnail string
preview_file_name Name of the preview string
is_shared True if the document is shared boolean
remote_id ID of file on third party storage provider string
remote_icon_url URL to icon for file on third party storage string

Status

200

Headers

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

Body

{
  "id": 1,
  "type": "UploadedDocument",
  "data_file_name": "awesome_report_7.txt",
  "data_file_size": 10,
  "data_content_type": "text/plain",
  "data_updated_at": "2022-02-23T09:59:31-03:00",
  "file_name": "awesome_report_7.txt",
  "file_size": 10,
  "file_content_type": "text/plain",
  "file_extension": "txt",
  "uploaded_at": "2022-02-23T09:59:31-03:00",
  "transfered": true,
  "uploader_id": "coyote-217",
  "uploader_name": "Coyote 217",
  "attachable_id": 1,
  "attachable_type": "Task",
  "attachable_name": "Bla",
  "thumbnail_file_name": null,
  "preview_file_name": null,
  "is_shared": false,
  "remote_id": null,
  "remote_icon_url": null,
  "evaluations": [

  ]
}
GET

/api/v1.0/documents/:id/download

Download a document

Request

Route

GET /api/v1.0/documents/1/download

Headers

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

cURL

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

Response

Simulated Response

Status

302

Headers

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

Body

<html><body>You are being <a href="https://s3.amazonaws.com/runrunit_dev/data/1/awesome_report_8.txt?AWSAccessKeyId=ABCDEFGHIJKLMNOPQRST&amp;Expires=1542388606&amp;Signature=NJrOAzy4oepfSNVvNn2NomG%2BKb4%3D&amp;response-content-disposition=inline&amp;response-content-type=text%2Fplain">redirected</a>.</body></html>
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://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

204

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=3%2C2%2C1

Headers

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

Query Parameters

ids=3,2,1

cURL

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

Response

Simulated Response

Status

302

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=28bd530c-264a-4c20-84aa-7248bb23e49b&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-196

Headers

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

cURL

curl "https://runrun.it/api/v1.0/enterprises/acme-196" -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
avatar_url Enterprise avatar url url
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
total_users_sum Total of users in account integer
total_guests_sum Total of guests in account integer
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
disabled_at Disabled date datetime
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
signup_qualified True if signup qualified boolean
signup_setup_team True if signup setup team boolean
time_zone Enterprise time zone string
language Enterprise language string
should_see_promo_modal True if Enterprise should see promo modal (internal use only) boolean
master_user_position Enterprise master user position 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[max_guests] Total number of guests which can be active integer
plan[max_open_tasks] Limit of open tasks in the account integer
plan[max_assignees_per_task] Limit of assignees per task integer
plan[max_boards] Limit of boards in account integer
plan[max_widgets_per_dashboard] Limit of widgets per dashboard integer
plan[max_document_size] Max size in bytes for documents float
plan[max_period_days] Max period days 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

200

Headers

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

Body

{
  "id": "acme-196",
  "name": "Acme 196",
  "avatar_url": "/packs/media/images/enterprise-avatar-fallback-132d08ff.png",
  "phone": null,
  "country": null,
  "company_size": "666",
  "company_sector": "technology",
  "attachments_sum": 0.0,
  "total_users_sum": 1,
  "total_guests_sum": 0,
  "remaining_attachment_space": 858993459200.0,
  "logo_url": "/logos/small/missing.png",
  "alt_id": "56b85c21b67d68b068f7dd5a15528775",
  "oid": "49537adb9",
  "support_phone": "+55 11 2769-9713",
  "trial_days_left": 30,
  "disabled_reason": null,
  "disabled_at": null,
  "currency_symbol": "USD",
  "created_at": "2022-02-23T10:00:06-03:00",
  "master_user_id": "coyote-256",
  "using_temporary_edition": false,
  "temporary_edition_expiration": null,
  "signup_completed": false,
  "signup_qualified": false,
  "signup_setup_team": false,
  "time_zone": "America/Sao_Paulo",
  "language": "en-GB",
  "should_see_promo_modal": false,
  "master_user_position": null,
  "default_board_id": null,
  "use_board_feature": true,
  "optional_use_board_feature": true,
  "subscription_expiration_date": "2022-03-25",
  "invite_user_link_code": null,
  "is_beta_tester": false,
  "plan": {
    "id": 1,
    "name_pt": "Plano Teste",
    "name_en": "Plan Trial",
    "max_storage": 858993459200.0,
    "max_users": 100,
    "max_guests": 10,
    "max_open_tasks": null,
    "max_assignees_per_task": null,
    "max_boards": null,
    "max_widgets_per_dashboard": null,
    "max_document_size": null,
    "max_period_days": null,
    "is_free": false,
    "is_trial": true,
    "can_use_mobile": true
  },
  "configuration": {
    "permitted_user_inviters": "everybody",
    "new_users_mutual_partners_by_default": true,
    "use_project_group_level": false,
    "use_project_sub_group_level": false,
    "only_admins_can_delete_tasks": false,
    "only_partners_can_be_mentioned": false,
    "only_partners_can_be_added_as_followers": false,
    "use_bulletin": true,
    "is_rating_public": true,
    "extra_users": 0,
    "custom_max_guests": null,
    "comment_document_change_window": 900,
    "use_block_user_by_time_worked_min": false,
    "use_block_user_by_time_worked_max": false,
    "block_user_by_time_worked_percentage_min": 50,
    "block_user_by_time_worked_percentage_max": 100,
    "use_advanced_password_policy": false,
    "optional_use_new_permissions": false,
    "use_board_lead_time_to_estimate": true,
    "deliver_task_after_last_assignment_delivery": false,
    "use_project_rr_board": false,
    "feature_task_list_sort_by_priority": true,
    "allow_create_tasks_without_project": true,
    "allow_resource_sharing": true,
    "request_time_adjust_on_task_assignment_deliver": false,
    "use_scrum": false,
    "allow_everyone_to_create_forms": true,
    "allow_everyone_to_manage_tags": false
  }
}
GET

/api/v1.0/enterprises/:id

Show details for requesting user's enterprise

Request

Route

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

Headers

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

cURL

curl "https://runrun.it/api/v1.0/enterprises/acme-196" -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
avatar_url Enterprise avatar url url
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
total_users_sum Total of users in account integer
total_guests_sum Total of guests in account integer
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
disabled_at Disabled date datetime
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
signup_qualified True if signup qualified boolean
signup_setup_team True if signup setup team boolean
time_zone Enterprise time zone string
language Enterprise language string
should_see_promo_modal True if Enterprise should see promo modal (internal use only) boolean
master_user_position Enterprise master user position 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[max_guests] Total number of guests which can be active integer
plan[max_open_tasks] Limit of open tasks in the account integer
plan[max_assignees_per_task] Limit of assignees per task integer
plan[max_boards] Limit of boards in account integer
plan[max_widgets_per_dashboard] Limit of widgets per dashboard integer
plan[max_document_size] Max size in bytes for documents float
plan[max_period_days] Max period days 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

200

Headers

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

Body

{
  "id": "acme-196",
  "name": "Acme 196",
  "avatar_url": "/packs/media/images/enterprise-avatar-fallback-132d08ff.png",
  "phone": null,
  "country": null,
  "company_size": "666",
  "company_sector": "technology",
  "attachments_sum": 0.0,
  "total_users_sum": 1,
  "total_guests_sum": 0,
  "remaining_attachment_space": 858993459200.0,
  "logo_url": "/logos/small/missing.png",
  "alt_id": "56b85c21b67d68b068f7dd5a15528775",
  "oid": "49537adb9",
  "support_phone": "+55 11 2769-9713",
  "trial_days_left": 30,
  "disabled_reason": null,
  "disabled_at": null,
  "currency_symbol": "USD",
  "created_at": "2022-02-23T10:00:06-03:00",
  "master_user_id": "coyote-256",
  "using_temporary_edition": false,
  "temporary_edition_expiration": null,
  "signup_completed": false,
  "signup_qualified": false,
  "signup_setup_team": false,
  "time_zone": "America/Sao_Paulo",
  "language": "en-GB",
  "should_see_promo_modal": false,
  "master_user_position": null,
  "default_board_id": null,
  "use_board_feature": true,
  "optional_use_board_feature": true,
  "subscription_expiration_date": "2022-03-25",
  "invite_user_link_code": null,
  "is_beta_tester": false,
  "plan": {
    "id": 1,
    "name_pt": "Plano Teste",
    "name_en": "Plan Trial",
    "max_storage": 858993459200.0,
    "max_users": 100,
    "max_guests": 10,
    "max_open_tasks": null,
    "max_assignees_per_task": null,
    "max_boards": null,
    "max_widgets_per_dashboard": null,
    "max_document_size": null,
    "max_period_days": null,
    "is_free": false,
    "is_trial": true,
    "can_use_mobile": true
  },
  "configuration": {
    "permitted_user_inviters": "everybody",
    "new_users_mutual_partners_by_default": true,
    "use_project_group_level": false,
    "use_project_sub_group_level": false,
    "only_admins_can_delete_tasks": false,
    "only_partners_can_be_mentioned": false,
    "only_partners_can_be_added_as_followers": false,
    "use_bulletin": true,
    "is_rating_public": true,
    "extra_users": 0,
    "custom_max_guests": null,
    "comment_document_change_window": 900,
    "use_block_user_by_time_worked_min": false,
    "use_block_user_by_time_worked_max": false,
    "block_user_by_time_worked_percentage_min": 50,
    "block_user_by_time_worked_percentage_max": 100,
    "use_advanced_password_policy": false,
    "optional_use_new_permissions": false,
    "use_board_lead_time_to_estimate": true,
    "deliver_task_after_last_assignment_delivery": false,
    "use_project_rr_board": false,
    "feature_task_list_sort_by_priority": true,
    "allow_create_tasks_without_project": true,
    "allow_resource_sharing": true,
    "request_time_adjust_on_task_assignment_deliver": false,
    "use_scrum": false,
    "allow_everyone_to_create_forms": true,
    "allow_everyone_to_manage_tags": 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-197

Headers

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

Body

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

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "acme-197",
  "name": "New name",
  "avatar_url": "/packs/media/images/enterprise-avatar-fallback-132d08ff.png",
  "phone": null,
  "country": null,
  "company_size": "666",
  "company_sector": "technology",
  "attachments_sum": 0.0,
  "total_users_sum": 1,
  "total_guests_sum": 0,
  "remaining_attachment_space": 858993459200.0,
  "logo_url": "/logos/small/missing.png",
  "alt_id": "6ff9379d536cfa49bcb1d34e91da4c5b",
  "oid": "49537adb9",
  "support_phone": "+55 11 2769-9713",
  "trial_days_left": 30,
  "disabled_reason": null,
  "disabled_at": null,
  "currency_symbol": "USD",
  "created_at": "2022-02-23T10:00:07-03:00",
  "master_user_id": "coyote-257",
  "using_temporary_edition": false,
  "temporary_edition_expiration": null,
  "signup_completed": false,
  "signup_qualified": false,
  "signup_setup_team": false,
  "time_zone": "America/Sao_Paulo",
  "language": "en-GB",
  "should_see_promo_modal": false,
  "master_user_position": null,
  "default_board_id": null,
  "use_board_feature": true,
  "optional_use_board_feature": true,
  "subscription_expiration_date": "2022-03-25",
  "invite_user_link_code": null,
  "is_beta_tester": false,
  "plan": {
    "id": 1,
    "name_pt": "Plano Teste",
    "name_en": "Plan Trial",
    "max_storage": 858993459200.0,
    "max_users": 100,
    "max_guests": 10,
    "max_open_tasks": null,
    "max_assignees_per_task": null,
    "max_boards": null,
    "max_widgets_per_dashboard": null,
    "max_document_size": null,
    "max_period_days": null,
    "is_free": false,
    "is_trial": true,
    "can_use_mobile": true
  },
  "configuration": {
    "permitted_user_inviters": "everybody",
    "new_users_mutual_partners_by_default": true,
    "use_project_group_level": false,
    "use_project_sub_group_level": false,
    "only_admins_can_delete_tasks": false,
    "only_partners_can_be_mentioned": false,
    "only_partners_can_be_added_as_followers": false,
    "use_bulletin": true,
    "is_rating_public": true,
    "extra_users": 0,
    "custom_max_guests": null,
    "comment_document_change_window": 900,
    "use_block_user_by_time_worked_min": false,
    "use_block_user_by_time_worked_max": false,
    "block_user_by_time_worked_percentage_min": 50,
    "block_user_by_time_worked_percentage_max": 100,
    "use_advanced_password_policy": false,
    "optional_use_new_permissions": false,
    "use_board_lead_time_to_estimate": true,
    "deliver_task_after_last_assignment_delivery": false,
    "use_project_rr_board": false,
    "feature_task_list_sort_by_priority": true,
    "allow_create_tasks_without_project": true,
    "allow_resource_sharing": true,
    "request_time_adjust_on_task_assignment_deliver": false,
    "use_scrum": false,
    "allow_everyone_to_create_forms": true,
    "allow_everyone_to_manage_tags": 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://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

200

Headers

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

Body

[
  {
    "id": 2,
    "task_id": 1,
    "work_seconds": 3600,
    "created_at": "2018-11-16T14:18:55-02:00",
    "is_standard": false
  },
  {
    "id": 3,
    "task_id": 1,
    "work_seconds": 7200,
    "created_at": "2018-11-16T14:18:55-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://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

201

Headers

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

Body

{
  "id": 3,
  "task_id": 1,
  "work_seconds": 9000,
  "created_at": "2018-11-16T14:19:11-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://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

200

Headers

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

Body

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

    ],
    "conditions": [

    ],
    "sorting": [
      {
        "column_id": "activities",
        "dir": "desc"
      }
    ],
    "sort": {
      "column_id": "activities",
      "dir": "desc"
    },
    "valid": true,
    "default": true,
    "preset": true
  },
  {
    "id": "open",
    "name": "open",
    "status": "open",
    "restriction": [
      {
        "column_id": "open",
        "operator": "is_true",
        "value": null,
        "valid": true
      }
    ],
    "conditions": [
      {
        "column_id": "open",
        "operator": "is_true",
        "value": null,
        "valid": true
      }
    ],
    "sorting": [
      {
        "column_id": "activities",
        "dir": "desc",
        "valid": true
      }
    ],
    "sort": {
      "column_id": "activities",
      "dir": "desc",
      "valid": true
    },
    "valid": true,
    "default": false,
    "preset": true
  },
  {
    "id": "closed",
    "name": "closed",
    "status": "closed",
    "restriction": [
      {
        "column_id": "open",
        "operator": "is_false",
        "value": null,
        "valid": true
      }
    ],
    "conditions": [
      {
        "column_id": "open",
        "operator": "is_false",
        "value": null,
        "valid": true
      }
    ],
    "sorting": [
      {
        "column_id": "close_date",
        "dir": "desc",
        "valid": true
      }
    ],
    "sort": {
      "column_id": "close_date",
      "dir": "desc",
      "valid": true
    },
    "valid": true,
    "default": false,
    "preset": true
  },
  {
    "id": 1,
    "name": "Amazing Projects",
    "status": "all",
    "restriction": [
      {
        "column_id": "open",
        "operator": "is_false",
        "value": null,
        "valid": true
      },
      {
        "column_id": "desired_date",
        "operator": "up_to",
        "value": "2016-10-02",
        "valid": true
      },
      {
        "column_id": "time_total",
        "operator": "greater_than",
        "value": 1000,
        "valid": true
      }
    ],
    "conditions": [
      {
        "column_id": "open",
        "operator": "is_false",
        "value": null,
        "valid": true
      },
      {
        "column_id": "desired_date",
        "operator": "up_to",
        "value": "2016-10-02",
        "valid": true
      },
      {
        "column_id": "time_total",
        "operator": "greater_than",
        "value": 1000,
        "valid": true
      }
    ],
    "sorting": [
      {
        "column_id": "desired_date",
        "dir": "desc",
        "valid": true
      }
    ],
    "sort": {
      "column_id": "desired_date",
      "dir": "desc",
      "valid": true
    },
    "valid": true,
    "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://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

200

Headers

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

Body

{
  "id": 1,
  "name": "Amazing Projects",
  "status": "all",
  "restriction": [
    {
      "column_id": "open",
      "operator": "is_false",
      "value": null,
      "valid": true
    },
    {
      "column_id": "desired_date",
      "operator": "up_to",
      "value": "2016-10-02",
      "valid": true
    },
    {
      "column_id": "time_total",
      "operator": "greater_than",
      "value": 1000,
      "valid": true
    }
  ],
  "conditions": [
    {
      "column_id": "open",
      "operator": "is_false",
      "value": null,
      "valid": true
    },
    {
      "column_id": "desired_date",
      "operator": "up_to",
      "value": "2016-10-02",
      "valid": true
    },
    {
      "column_id": "time_total",
      "operator": "greater_than",
      "value": 1000,
      "valid": true
    }
  ],
  "sorting": [
    {
      "column_id": "desired_date",
      "dir": "desc",
      "valid": true
    }
  ],
  "sort": {
    "column_id": "desired_date",
    "dir": "desc",
    "valid": true
  },
  "valid": true,
  "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": "all",
    "conditions": [
      {
        "column_id": "open",
        "operator": "is_false",
        "value": null
      },
      {
        "column_id": "start_date",
        "operator": "up_to",
        "value": "2016-10-02"
      },
      {
        "column_id": "tasks_count",
        "operator": "greater_than",
        "value": 2
      }
    ]
  }
}

cURL

curl "https://runrun.it/api/v1.0/projects/filters" -d '{"filter":{"name":"Failing projects","status":"all","conditions":[{"column_id":"open","operator":"is_false","value":null},{"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

201

Headers

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

Body

{
  "id": 1,
  "name": "Failing projects",
  "status": "all",
  "restriction": [
    {
      "column_id": "open",
      "operator": "is_false",
      "value": null,
      "valid": true
    },
    {
      "column_id": "start_date",
      "operator": "up_to",
      "value": "2016-10-02",
      "valid": true
    },
    {
      "column_id": "tasks_count",
      "operator": "greater_than",
      "value": 2,
      "valid": true
    }
  ],
  "conditions": [
    {
      "column_id": "open",
      "operator": "is_false",
      "value": null,
      "valid": true
    },
    {
      "column_id": "start_date",
      "operator": "up_to",
      "value": "2016-10-02",
      "valid": true
    },
    {
      "column_id": "tasks_count",
      "operator": "greater_than",
      "value": 2,
      "valid": true
    }
  ],
  "sorting": [

  ],
  "sort": null,
  "valid": true,
  "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://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

200

Headers

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

Body

{
  "id": 1,
  "name": "Another name",
  "status": "all",
  "restriction": [

  ],
  "conditions": [

  ],
  "sorting": [

  ],
  "sort": null,
  "valid": true,
  "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://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

204

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://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

200

Headers

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

Body

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

    ],
    "conditions": [

    ],
    "sorting": [
      {
        "column_id": "activities",
        "dir": "desc"
      }
    ],
    "sort": {
      "column_id": "activities",
      "dir": "desc"
    },
    "valid": true,
    "default": true,
    "preset": true
  },
  {
    "id": "not_assigned",
    "name": "not_assigned",
    "status": "all",
    "restriction": [
      {
        "column_id": "assignees",
        "operator": "is_empty",
        "value": null,
        "valid": true
      },
      {
        "column_id": "state",
        "operator": "is_not",
        "value": "closed",
        "valid": true
      }
    ],
    "conditions": [
      {
        "column_id": "assignees",
        "operator": "is_empty",
        "value": null,
        "valid": true
      },
      {
        "column_id": "state",
        "operator": "is_not",
        "value": "closed",
        "valid": true
      }
    ],
    "sorting": [
      {
        "column_id": "priority",
        "dir": "asc",
        "valid": true
      }
    ],
    "sort": {
      "column_id": "priority",
      "dir": "asc",
      "valid": true
    },
    "valid": true,
    "default": false,
    "preset": true
  },
  {
    "id": "queued",
    "name": "queued",
    "status": "all",
    "restriction": [
      {
        "column_id": "state",
        "operator": "is",
        "value": "queued",
        "valid": true
      }
    ],
    "conditions": [
      {
        "column_id": "state",
        "operator": "is",
        "value": "queued",
        "valid": true
      }
    ],
    "sorting": [
      {
        "column_id": "activities",
        "dir": "desc",
        "valid": true
      }
    ],
    "sort": {
      "column_id": "activities",
      "dir": "desc",
      "valid": true
    },
    "valid": true,
    "default": false,
    "preset": true
  },
  {
    "id": "working_on",
    "name": "working_on",
    "status": "all",
    "restriction": [
      {
        "column_id": "state",
        "operator": "is",
        "value": "working_on",
        "valid": true
      }
    ],
    "conditions": [
      {
        "column_id": "state",
        "operator": "is",
        "value": "working_on",
        "valid": true
      }
    ],
    "sorting": [
      {
        "column_id": "activities",
        "dir": "desc",
        "valid": true
      }
    ],
    "sort": {
      "column_id": "activities",
      "dir": "desc",
      "valid": true
    },
    "valid": true,
    "default": false,
    "preset": true
  },
  {
    "id": "open",
    "name": "open",
    "status": "all",
    "restriction": [
      {
        "column_id": "state",
        "operator": "is_not",
        "value": "closed",
        "valid": true
      }
    ],
    "conditions": [
      {
        "column_id": "state",
        "operator": "is_not",
        "value": "closed",
        "valid": true
      }
    ],
    "sorting": [
      {
        "column_id": "priority",
        "dir": "asc",
        "valid": true
      }
    ],
    "sort": {
      "column_id": "priority",
      "dir": "asc",
      "valid": true
    },
    "valid": true,
    "default": false,
    "preset": true
  },
  {
    "id": "delivered",
    "name": "delivered",
    "status": "all",
    "restriction": [
      {
        "column_id": "state",
        "operator": "is",
        "value": "closed",
        "valid": true
      }
    ],
    "conditions": [
      {
        "column_id": "state",
        "operator": "is",
        "value": "closed",
        "valid": true
      }
    ],
    "sorting": [
      {
        "column_id": "close_date",
        "dir": "desc",
        "valid": true
      }
    ],
    "sort": {
      "column_id": "close_date",
      "dir": "desc",
      "valid": true
    },
    "valid": true,
    "default": false,
    "preset": true
  },
  {
    "id": "delivered_in_the_last_7_days",
    "name": "delivered_in_the_last_7_days",
    "status": "all",
    "restriction": [
      {
        "column_id": "close_date",
        "operator": "in_the_last",
        "value": "seven_days",
        "valid": true
      },
      {
        "column_id": "state",
        "operator": "is",
        "value": "closed",
        "valid": true
      }
    ],
    "conditions": [
      {
        "column_id": "close_date",
        "operator": "in_the_last",
        "value": "seven_days",
        "valid": true
      },
      {
        "column_id": "state",
        "operator": "is",
        "value": "closed",
        "valid": true
      }
    ],
    "sorting": [
      {
        "column_id": "close_date",
        "dir": "desc",
        "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",
    "restriction": [
      {
        "column_id": "estimated_delivery_date",
        "operator": "in_the_next",
        "value": "seven_days",
        "valid": true
      },
      {
        "column_id": "state",
        "operator": "is_not",
        "value": "closed",
        "valid": true
      }
    ],
    "conditions": [
      {
        "column_id": "estimated_delivery_date",
        "operator": "in_the_next",
        "value": "seven_days",
        "valid": true
      },
      {
        "column_id": "state",
        "operator": "is_not",
        "value": "closed",
        "valid": true
      }
    ],
    "sorting": [
      {
        "column_id": "activities",
        "dir": "desc",
        "valid": true
      }
    ],
    "sort": {
      "column_id": "activities",
      "dir": "desc",
      "valid": true
    },
    "valid": true,
    "default": false,
    "preset": true
  },
  {
    "id": "overdue",
    "name": "overdue",
    "status": "all",
    "restriction": [
      {
        "column_id": "overdue",
        "operator": "is",
        "value": "hard_overdue",
        "valid": true
      },
      {
        "column_id": "state",
        "operator": "is_not",
        "value": "closed",
        "valid": true
      }
    ],
    "conditions": [
      {
        "column_id": "overdue",
        "operator": "is",
        "value": "hard_overdue",
        "valid": true
      },
      {
        "column_id": "state",
        "operator": "is_not",
        "value": "closed",
        "valid": true
      }
    ],
    "sorting": [
      {
        "column_id": "desired_date",
        "dir": "asc",
        "valid": true
      }
    ],
    "sort": {
      "column_id": "desired_date",
      "dir": "asc",
      "valid": true
    },
    "valid": true,
    "default": false,
    "preset": true
  },
  {
    "id": "overdue_estimated",
    "name": "overdue_estimated",
    "status": "all",
    "restriction": [
      {
        "column_id": "overdue",
        "operator": "is",
        "value": "soft_overdue",
        "valid": true
      },
      {
        "column_id": "state",
        "operator": "is_not",
        "value": "closed",
        "valid": true
      }
    ],
    "conditions": [
      {
        "column_id": "overdue",
        "operator": "is",
        "value": "soft_overdue",
        "valid": true
      },
      {
        "column_id": "state",
        "operator": "is_not",
        "value": "closed",
        "valid": true
      }
    ],
    "sorting": [
      {
        "column_id": "desired_date",
        "dir": "asc",
        "valid": true
      }
    ],
    "sort": {
      "column_id": "desired_date",
      "dir": "asc",
      "valid": true
    },
    "valid": true,
    "default": false,
    "preset": true
  },
  {
    "id": "shared",
    "name": "shared",
    "status": "all",
    "restriction": [
      {
        "column_id": "is_shared",
        "operator": "is_true",
        "value": null,
        "valid": true
      }
    ],
    "conditions": [
      {
        "column_id": "is_shared",
        "operator": "is_true",
        "value": null,
        "valid": true
      }
    ],
    "sorting": [
      {
        "column_id": "activities",
        "dir": "desc",
        "valid": true
      }
    ],
    "sort": {
      "column_id": "activities",
      "dir": "desc",
      "valid": true
    },
    "valid": true,
    "default": false,
    "preset": true
  },
  {
    "id": 1,
    "name": "Amazing Tasks",
    "status": "all",
    "restriction": [
      {
        "column_id": "title",
        "operator": "contains",
        "value": "Test",
        "valid": true
      },
      {
        "column_id": "state",
        "operator": "is",
        "value": "queued",
        "valid": true
      }
    ],
    "conditions": [
      {
        "column_id": "title",
        "operator": "contains",
        "value": "Test",
        "valid": true
      },
      {
        "column_id": "state",
        "operator": "is",
        "value": "queued",
        "valid": true
      }
    ],
    "sorting": [
      {
        "column_id": "title",
        "dir": "asc",
        "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://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

200

Headers

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

Body

{
  "id": 1,
  "name": "Amazing Tasks",
  "status": "all",
  "restriction": [
    {
      "column_id": "title",
      "operator": "contains",
      "value": "Test",
      "valid": true
    },
    {
      "column_id": "state",
      "operator": "is",
      "value": "queued",
      "valid": true
    }
  ],
  "conditions": [
    {
      "column_id": "title",
      "operator": "contains",
      "value": "Test",
      "valid": true
    },
    {
      "column_id": "state",
      "operator": "is",
      "value": "queued",
      "valid": true
    }
  ],
  "sorting": [
    {
      "column_id": "title",
      "dir": "asc",
      "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://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

201

Headers

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

Body

{
  "id": 1,
  "name": "Test tasks",
  "status": "all",
  "restriction": [
    {
      "column_id": "title",
      "operator": "contains",
      "value": "Teste",
      "valid": true
    }
  ],
  "conditions": [
    {
      "column_id": "title",
      "operator": "contains",
      "value": "Teste",
      "valid": true
    }
  ],
  "sorting": [

  ],
  "sort": null,
  "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://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

200

Headers

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

Body

{
  "id": 1,
  "name": "Another name",
  "status": "all",
  "restriction": [

  ],
  "conditions": [

  ],
  "sorting": [

  ],
  "sort": null,
  "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://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

204

Headers

Justifications

POST

/api/v1.0/justifications

Create an arbitrary Justification

Request

Route

POST /api/v1.0/justifications

Headers

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

Body

{
  "text": "New Justification 1",
  "date": "2018-11-15"
}

cURL

curl "https://runrun.it/api/v1.0/justifications" -d '{"text":"New Justification 1","date":"2018-11-15"}' -X POST \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

201

Headers

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

Body

{
  "id": 1,
  "user_id": "coyote-214",
  "date": "2018-11-15",
  "text": "New Justification 1",
  "task_id": null,
  "task_title": null
}
POST

/api/v1.0/justifications

Create an arbitrary Justification for a task

Request

Route

POST /api/v1.0/justifications

Headers

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

Body

{
  "text": "New Justification 2",
  "date": "2018-11-15",
  "task_id": 1
}

cURL

curl "https://runrun.it/api/v1.0/justifications" -d '{"text":"New Justification 2","date":"2018-11-15","task_id":1}' -X POST \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

201

Headers

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

Body

{
  "id": 1,
  "user_id": "coyote-215",
  "date": "2018-11-15",
  "text": "New Justification 2",
  "task_id": 1,
  "task_title": "Bla"
}
PUT

/api/v1.0/justifications/:justification_id

Update the text of a justification

Parameters

Name Description type
user_id

User's id

integer

date

Justification's date

date

text required

Justification's text

string

task_id required

Task's id

integer

task_title

Task title

string

Request

Route

PUT /api/v1.0/justifications/1

Headers

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

Body

{
  "text": "Old justification with a new text"
}

cURL

curl "https://runrun.it/api/v1.0/justifications/1" -d '{"text":"Old justification with a new text"}' -X PUT \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": 1,
  "user_id": "coyote-360",
  "date": "2022-02-21",
  "text": "Old justification with a new text",
  "task_id": null,
  "task_title": null
}

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, 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[from]

date_time

manual_work_period[before]

date_time

Request

Route

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

Headers

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

Query Parameters

task_id=1

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

[
  {
    "id": 1,
    "task_id": 1,
    "seconds": 1000,
    "date_to_apply": "2019-02-08",
    "worker_name": "Coyote 1",
    "user_id": "coyote-1",
    "team_id": null,
    "team_name": null,
    "board_stage_id": null,
    "board_stage_name": null,
    "task_state_id": null,
    "task_status_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

Headers

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

cURL

curl "https://runrun.it/api/v1.0/manual_work_periods/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 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
team_name Name of the team associated to the manual work period string
board_stage_id ID of board stage associated to the manual work period integer
board_stage_name Name of the board stage associated to the manual work period string
task_state_id [Deprecated] Use board_stage_id integer
task_status_id [Deprecated] Use board_stage_id integer

Status

200

Headers

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

Body

{
  "id": 1,
  "task_id": 1,
  "seconds": 1000,
  "date_to_apply": "2019-02-08",
  "worker_name": "Coyote 2",
  "user_id": "coyote-2",
  "team_id": null,
  "team_name": null,
  "board_stage_id": null,
  "board_stage_name": null,
  "task_state_id": null,
  "task_status_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 the logged in user on a specific team and board stage, on a specific day.

Parameters

Name Description type
manual_work_period[task_id] required

ID of related task

integer

manual_work_period[board_stage_id]

ID of board stage 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": {
    "task_id": 1,
    "seconds": 3600,
    "date_to_apply": "2019-02-08"
  }
}

cURL

curl "https://runrun.it/api/v1.0/manual_work_periods" -d '{"manual_work_period":{"task_id":1,"seconds":3600,"date_to_apply":"2019-02-08"}}' -X POST \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

201

Headers

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

Body

{
  "id": 1,
  "task_id": 1,
  "seconds": 3600,
  "date_to_apply": "2019-02-08",
  "worker_name": "Coyote 3",
  "user_id": "coyote-3",
  "team_id": null,
  "team_name": null,
  "board_stage_id": null,
  "board_stage_name": null,
  "task_state_id": null,
  "task_status_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

{
  "manual_work_period": {
    "seconds": 2000
  }
}

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": 1,
  "task_id": 1,
  "seconds": 2000,
  "date_to_apply": "2019-02-08",
  "worker_name": "Coyote 4",
  "user_id": "coyote-4",
  "team_id": null,
  "team_name": null,
  "board_stage_id": null,
  "board_stage_name": null,
  "task_state_id": null,
  "task_status_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

cURL

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

Response

Simulated Response

Status

204

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://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

200

Headers

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

Body

[
  {
    "id": 2,
    "day": "2018-11-18",
    "description": "Ice Cream Day"
  },
  {
    "id": 1,
    "day": "2018-11-17",
    "description": "Developer 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://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

200

Headers

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

Body

{
  "id": 1,
  "day": "2018-11-19",
  "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": "2018-11-20",
    "description": "City holiday 2"
  }
}

cURL

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

Response

Simulated Response

Status

201

Headers

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

Body

{
  "id": 1,
  "day": "2018-11-20",
  "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://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

200

Headers

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

Body

{
  "id": 1,
  "day": "2018-11-21",
  "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://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

204

Headers

PartnerTeams

GET

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

List all partner_teams

List all partner_teams that the current user can view.

Request

Route

GET /api/v1.0/users/coyote-251/partner_teams

Headers

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

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

[
  {
    "id": 1,
    "name": "Team_A",
    "master_user_id": "coyote-251",
    "master_user_name": "Coyote 251",
    "cost_center": null,
    "user_ids": [
      "coyote-251"
    ]
  }
]

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-392/partners

Headers

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

cURL

curl "https://runrun.it/api/v1.0/users/coyote-392/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
cost_hour Current user cost per hour decimal
is_master User is an administrator boolean
is_manager User is a manager boolean
is_auditor User is an auditor boolean
can_create_client_project_and_task_types User has permission to create client, projects and task types boolean
can_create_boards User has permission to create boards boolean
is_blocked_on_mobile User has mobile apps access blocked boolean
bypass_block_by_time_worked User ignore the blocking rule for time worked 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
created_at User creation date datetime
in_company_since Joining date in company date
is_certified Whether the user has passed Runrun.it certification boolean
language User preference language string
alt_id Constant size ID (internal use only) string
oid Constant size ID (internal use only) string
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
blocked_by_time_worked_at When the user is blocked for being out of the acceptable worked time defined by the company datetime
demanders_count Demanders count integer
partners_count Partners count integer
has_all_users_as_partners True if user has all users as partners boolean
has_all_users_as_demanders True if has all users as demanders boolean
password_updated_at Last time user password was updated datetime
password_expired_at Time when the user password was considered expired datetime
shift_work_time_per_week Shift work time (in seconds) per week integer
admin_runrunit_roles Runrun.it admin roles (internal use only) array
team_ids Ids from teams that the user belongs to array
led_team_ids Ids from teams the user leads array
legacy_on_vacation Internal use only boolean
skip_time_adjust_on_task_assignment_deliver User preference of skip adjust time modal on task deliver boolean
theme User preference of theme for interface between light or dark mode string
task_list_background_image_url Image url for background of task list string

Status

200

Headers

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

Body

[
  {
    "id": "coyote-393",
    "name": "Coyote 393",
    "email": "coyote379@acme.foo",
    "avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-428/coyote-393/mini.png",
    "avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-428/coyote-393/regular.png",
    "cost_hour": 0.0,
    "is_master": false,
    "is_manager": false,
    "is_auditor": false,
    "can_create_client_project_and_task_types": false,
    "can_create_boards": true,
    "is_blocked_on_mobile": false,
    "bypass_block_by_time_worked": false,
    "time_zone": "America/Sao_Paulo",
    "position": null,
    "on_vacation": false,
    "birthday": null,
    "phone": null,
    "gender": null,
    "marital_status": null,
    "created_at": "2022-02-23T10:02:44-03:00",
    "in_company_since": null,
    "is_certified": false,
    "language": "pt-BR",
    "alt_id": "d6b542ee2ff8ce388dacdae02c0c9d7f",
    "oid": "dbfa7092b",
    "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",
        "work_time": 0
      },
      {
        "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",
        "work_time": 28800
      },
      {
        "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",
        "work_time": 28800
      },
      {
        "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",
        "work_time": 28800
      },
      {
        "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",
        "work_time": 28800
      },
      {
        "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",
        "work_time": 28800
      },
      {
        "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",
        "work_time": 0
      }
    ],
    "is_mensurable": true,
    "time_tracking_mode": "smart",
    "blocked_by_time_worked_at": null,
    "demanders_count": 0,
    "partners_count": 0,
    "has_all_users_as_partners": false,
    "has_all_users_as_demanders": false,
    "password_updated_at": null,
    "password_expired_at": null,
    "shift_work_time_per_week": 144000,
    "team_ids": [

    ],
    "led_team_ids": [

    ],
    "skip_time_adjust_on_task_assignment_deliver": false,
    "theme": "light",
    "task_list_background_image_url": null,
    "is_authorized": true
  },
  {
    "id": "coyote-392",
    "name": "Coyote 392",
    "email": "coyote378@acme.foo",
    "avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-428/coyote-392/mini.png",
    "avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-428/coyote-392/regular.png",
    "cost_hour": 0.0,
    "is_master": false,
    "is_manager": false,
    "is_auditor": false,
    "can_create_client_project_and_task_types": false,
    "can_create_boards": true,
    "is_blocked_on_mobile": false,
    "bypass_block_by_time_worked": false,
    "time_zone": "America/Sao_Paulo",
    "position": null,
    "on_vacation": false,
    "birthday": null,
    "phone": null,
    "gender": null,
    "marital_status": null,
    "created_at": "2022-02-23T10:02:43-03:00",
    "in_company_since": null,
    "is_certified": false,
    "language": "pt-BR",
    "alt_id": "01d026d86216edc09e28ee928e3b52b1",
    "oid": "92a6f5b72",
    "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",
        "work_time": 0
      },
      {
        "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",
        "work_time": 28800
      },
      {
        "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",
        "work_time": 28800
      },
      {
        "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",
        "work_time": 28800
      },
      {
        "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",
        "work_time": 28800
      },
      {
        "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",
        "work_time": 28800
      },
      {
        "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",
        "work_time": 0
      }
    ],
    "is_mensurable": true,
    "time_tracking_mode": "smart",
    "blocked_by_time_worked_at": null,
    "demanders_count": 0,
    "partners_count": 0,
    "has_all_users_as_partners": false,
    "has_all_users_as_demanders": false,
    "password_updated_at": null,
    "password_expired_at": null,
    "shift_work_time_per_week": 144000,
    "team_ids": [

    ],
    "led_team_ids": [

    ],
    "skip_time_adjust_on_task_assignment_deliver": false,
    "theme": "light",
    "task_list_background_image_url": null,
    "is_authorized": 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-400/partners

Headers

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

Body

{
  "partner_id": "coyote-402"
}

cURL

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

Response

Simulated Response

Status

201

Headers

Content-Type: application/json
Content-Length: 0
POST

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

Replace a user partners list

Parameters

Name Description type
user_id required

User's ID

string

Request

Route

POST /api/v1.0/users/coyote-260/partners/replace

Headers

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

Body

{
  "ids": "coyote-262,coyote-263"
}

cURL

curl "https://runrun.it/api/v1.0/users/coyote-260/partners/replace" -d '{"ids":"coyote-262,coyote-263"}' -X POST \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

200

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-265/partners/coyote-266

Headers

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

cURL

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

Response

Simulated Response

Status

204

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://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

200

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://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 user creator string
guest_id Id of the comment user guest 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 comments in the thread integer
commentable_id The commentable id string
commentable_type To which resource type does this comment belongs string
created_at Datetime the comment has been made datetime
edited_at Datetime the comment has been edited datetime
deleted_at Datetime the comment has been deleted datetime
thread_id The actual text of the comment integer
quoted_comment_id Id of the quoted comment integer
quoted_comment_text First 140 characters of quoted comment string
quoted_comment_user_id Id of the quoted comment user creator string
quoted_comment_user_name The name of the quoted comment user creator string
quoted_comment_guest_id Id of the quoted comment user guest creator string
quoted_comment_guest_name The name of the quoted comment user guest creator string
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 document which the comment belong to integer
is_legacy True if comment was created before 2018-01-04 boolean
media Images, videos and websites informations json
documents Documents data array
reactions Reactions data array

Status

200

Headers

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

Body

[
  {
    "id": 1,
    "user_id": "coyote-461",
    "guest_id": null,
    "is_system_message": false,
    "text": "A enterprise post",
    "commenter_name": "Coyote 461",
    "children_count": 0,
    "commentable_id": "acme-483",
    "commentable_type": "Enterprise",
    "created_at": "2022-02-23T10:03:32-03:00",
    "edited_at": null,
    "deleted_at": null,
    "thread_id": 1,
    "quoted_comment_id": null,
    "quoted_comment_text": null,
    "quoted_comment_user_id": null,
    "quoted_comment_user_name": null,
    "quoted_comment_guest_id": null,
    "quoted_comment_guest_name": null,
    "task_id": null,
    "comment_id": null,
    "team_id": null,
    "enterprise_id": "acme-483",
    "document_id": null,
    "is_legacy": false,
    "media": null,
    "documents": [

    ],
    "reactions": [

    ],
    "lovers": [

    ]
  }
]
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://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

201

Headers

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

Body

{
  "id": 1,
  "user_id": "coyote-462",
  "guest_id": null,
  "is_system_message": false,
  "text": "A message",
  "commenter_name": "Coyote 462",
  "children_count": 0,
  "commentable_id": "acme-484",
  "commentable_type": "Enterprise",
  "created_at": "2022-02-23T10:03:33-03:00",
  "edited_at": null,
  "deleted_at": null,
  "thread_id": 1,
  "quoted_comment_id": null,
  "quoted_comment_text": null,
  "quoted_comment_user_id": null,
  "quoted_comment_user_name": null,
  "quoted_comment_guest_id": null,
  "quoted_comment_guest_name": null,
  "task_id": null,
  "comment_id": null,
  "team_id": null,
  "enterprise_id": "acme-484",
  "document_id": null,
  "is_legacy": false,
  "media": null,
  "documents": [

  ],
  "reactions": [

  ],
  "lovers": [

  ]
}
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://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 user creator string
guest_id Id of the comment user guest 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 comments in the thread integer
commentable_id The commentable id string
commentable_type To which resource type does this comment belongs string
created_at Datetime the comment has been made datetime
edited_at Datetime the comment has been edited datetime
deleted_at Datetime the comment has been deleted datetime
thread_id The actual text of the comment integer
quoted_comment_id Id of the quoted comment integer
quoted_comment_text First 140 characters of quoted comment string
quoted_comment_user_id Id of the quoted comment user creator string
quoted_comment_user_name The name of the quoted comment user creator string
quoted_comment_guest_id Id of the quoted comment user guest creator string
quoted_comment_guest_name The name of the quoted comment user guest creator string
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 document which the comment belong to integer
is_legacy True if comment was created before 2018-01-04 boolean
media Images, videos and websites informations json
documents Documents data array
reactions Reactions data array

Status

200

Headers

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

Body

[

]
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://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 user creator string
guest_id Id of the comment user guest 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 comments in the thread integer
commentable_id The commentable id string
commentable_type To which resource type does this comment belongs string
created_at Datetime the comment has been made datetime
edited_at Datetime the comment has been edited datetime
deleted_at Datetime the comment has been deleted datetime
thread_id The actual text of the comment integer
quoted_comment_id Id of the quoted comment integer
quoted_comment_text First 140 characters of quoted comment string
quoted_comment_user_id Id of the quoted comment user creator string
quoted_comment_user_name The name of the quoted comment user creator string
quoted_comment_guest_id Id of the quoted comment user guest creator string
quoted_comment_guest_name The name of the quoted comment user guest creator string
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 document which the comment belong to integer
is_legacy True if comment was created before 2018-01-04 boolean
media Images, videos and websites informations json
documents Documents data array
reactions Reactions data array

Status

201

Headers

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

Body

{
  "id": 1,
  "user_id": "coyote-466",
  "guest_id": null,
  "is_system_message": false,
  "text": "A message",
  "commenter_name": "Coyote 466",
  "children_count": 0,
  "commentable_id": 1,
  "commentable_type": "Team",
  "created_at": "2022-02-23T10:03:37-03:00",
  "edited_at": null,
  "deleted_at": null,
  "thread_id": 1,
  "quoted_comment_id": null,
  "quoted_comment_text": null,
  "quoted_comment_user_id": null,
  "quoted_comment_user_name": null,
  "quoted_comment_guest_id": null,
  "quoted_comment_guest_name": null,
  "task_id": null,
  "comment_id": null,
  "team_id": 1,
  "enterprise_id": null,
  "document_id": null,
  "is_legacy": false,
  "media": null,
  "documents": [

  ],
  "reactions": [

  ],
  "lovers": [

  ]
}

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/1/prerequisites

Headers

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

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

[
  {
    "id": 2,
    "title": "Bla",
    "is_working_on": false,
    "user_id": "coyote-470",
    "type_id": 2,
    "project_id": 2,
    "team_id": null,
    "board_id": 2,
    "board_stage_id": 4,
    "board_stage_position": 70368744177664,
    "subtask_parent_position": null,
    "desired_date": null,
    "desired_date_with_time": null,
    "estimated_start_date": null,
    "estimated_delivery_date": null,
    "gantt_bar_start_date": null,
    "gantt_bar_end_date": null,
    "close_date": null,
    "was_reopened": false,
    "is_closed": false,
    "is_assigned": true,
    "on_going": false,
    "estimate_updated": false,
    "estimated_at": null,
    "queue_position": 2,
    "created_at": "2022-02-23T10:03:39-03:00",
    "start_date": null,
    "desired_start_date": null,
    "current_estimate_seconds": 3600,
    "current_evaluator_id": null,
    "evaluation_status": null,
    "attachments_count": 0,
    "tags_data": [

    ],
    "client_name": "Test client 135",
    "client_id": 2,
    "project_name": "Test project 129",
    "project_group_name": "Sem grupo",
    "project_group_id": 2,
    "project_group_is_default": true,
    "project_sub_group_name": "Sem subgrupo",
    "project_sub_group_id": 2,
    "project_sub_group_is_default": true,
    "type_name": "TaskType 149",
    "user_name": "Coyote 470",
    "board_name": "Board 115",
    "board_stage_name": "Board Stage 347",
    "team_name": null,
    "type_color": "FFFFFF",
    "state": "queued",
    "overdue": "on_schedule",
    "time_worked": 0,
    "time_pending": 3600,
    "time_total": 3600,
    "time_progress": 0.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_days_ago": 0,
    "activities": 0,
    "repetition_rule": null,
    "board_remaining_time": null,
    "stage_depart_estimated_at": null,
    "is_urgent": false,
    "points": null,
    "reestimate_count": 0,
    "opened_parent_ids": [

    ],
    "parents_max_desired_date": null,
    "workflow_id": null,
    "checklist_id": null,
    "is_shared": false,
    "sharing_details": [

    ],
    "subtask_ids": [

    ],
    "subtasks_count": 0,
    "subtasks_closed_count": 0,
    "subtasks_count_progress": null,
    "is_subtask": false,
    "parent_task_id": null,
    "parent_task_title": null,
    "priority": 2,
    "tag_list": "",
    "tags": [

    ],
    "scheduled_start_time": null,
    "is_scheduled": false,
    "uid": 2,
    "responsible_id": "coyote-468",
    "task_state_id": 4,
    "responsible_name": "Coyote 468",
    "task_state_name": "Board Stage 347",
    "activities_7_days_ago": 0,
    "repetition_rule_id": null,
    "current_worked_time": 0,
    "estimated_delivery_date_updated": false,
    "last_estimated_at": null,
    "task_tags": [

    ],
    "approved": null,
    "task_status_id": 4,
    "task_status_name": "Board Stage 347",
    "assignments": [
      {
        "id": "92a6f5b72",
        "task_id": 2,
        "assignee_id": "coyote-468",
        "team_id": null,
        "assignee_name": "Coyote 468",
        "team_name": null,
        "queue_position": 2,
        "priority": 2,
        "current_estimate_seconds": 3600,
        "time_worked": 0,
        "estimated_start_date": null,
        "estimate_updated": false,
        "start_date": null,
        "close_date": null,
        "is_closed": false,
        "reestimate_count": 0,
        "is_working_on": false,
        "automatic_time_worked_updated_at": "2022-02-23T10:03:39-03:00",
        "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-488/coyote-468/mini.png",
        "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-488/coyote-468/regular.png",
        "time_worked_not_persisted": 0
      }
    ],
    "follower_ids": [

    ]
  }
]
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/1/prerequisites

Headers

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

Body

{
  "prerequisite": {
    "id": 2
  }
}

cURL

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

Response

Simulated Response

Status

201

Headers

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

Body

{
  "id": 2,
  "title": "Bla",
  "is_working_on": false,
  "user_id": "coyote-473",
  "type_id": 2,
  "project_id": 2,
  "team_id": null,
  "board_id": 2,
  "board_stage_id": 4,
  "board_stage_position": 70368744177664,
  "subtask_parent_position": null,
  "desired_date": null,
  "desired_date_with_time": null,
  "estimated_start_date": null,
  "estimated_delivery_date": null,
  "gantt_bar_start_date": null,
  "gantt_bar_end_date": null,
  "close_date": null,
  "was_reopened": false,
  "is_closed": false,
  "is_assigned": true,
  "on_going": false,
  "estimate_updated": false,
  "estimated_at": null,
  "queue_position": 2,
  "created_at": "2022-02-23T10:03:41-03:00",
  "start_date": null,
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "current_evaluator_id": null,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 137",
  "client_id": 2,
  "project_name": "Test project 131",
  "project_group_name": "Sem grupo",
  "project_group_id": 2,
  "project_group_is_default": true,
  "project_sub_group_name": "Sem subgrupo",
  "project_sub_group_id": 2,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 151",
  "user_name": "Coyote 473",
  "board_name": "Board 117",
  "board_stage_name": "Board Stage 353",
  "team_name": null,
  "type_color": "FFFFFF",
  "state": "queued",
  "overdue": "on_schedule",
  "time_worked": 0,
  "time_pending": 3600,
  "time_total": 3600,
  "time_progress": 0.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_days_ago": 0,
  "activities": 0,
  "repetition_rule": null,
  "board_remaining_time": null,
  "stage_depart_estimated_at": null,
  "is_urgent": false,
  "points": null,
  "reestimate_count": 0,
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "workflow_id": null,
  "checklist_id": null,
  "is_shared": false,
  "sharing_details": [

  ],
  "subtask_ids": [

  ],
  "subtasks_count": 0,
  "subtasks_closed_count": 0,
  "subtasks_count_progress": null,
  "is_subtask": false,
  "parent_task_id": null,
  "parent_task_title": null,
  "priority": 2,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "uid": 2,
  "responsible_id": "coyote-471",
  "task_state_id": 4,
  "responsible_name": "Coyote 471",
  "task_state_name": "Board Stage 353",
  "activities_7_days_ago": 0,
  "repetition_rule_id": null,
  "current_worked_time": 0,
  "estimated_delivery_date_updated": false,
  "last_estimated_at": null,
  "task_tags": [

  ],
  "approved": null,
  "task_status_id": 4,
  "task_status_name": "Board Stage 353",
  "assignments": [
    {
      "id": "92a6f5b72",
      "task_id": 2,
      "assignee_id": "coyote-471",
      "team_id": null,
      "assignee_name": "Coyote 471",
      "team_name": null,
      "queue_position": 2,
      "priority": 2,
      "current_estimate_seconds": 3600,
      "time_worked": 0,
      "estimated_start_date": null,
      "estimate_updated": false,
      "start_date": null,
      "close_date": null,
      "is_closed": false,
      "reestimate_count": 0,
      "is_working_on": false,
      "automatic_time_worked_updated_at": "2022-02-23T10:03:41-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-489/coyote-471/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-489/coyote-471/regular.png",
      "time_worked_not_persisted": 0
    }
  ],
  "follower_ids": [

  ]
}
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/1/prerequisites/2

Headers

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

cURL

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

Response

Simulated Response

Status

204

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/14/prerequisites

Headers

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

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

[
  {
    "id": 15,
    "title": "Task Template",
    "user_id": "coyote-479",
    "type_id": 2,
    "team_id": null,
    "board_id": null,
    "queue_position": 1,
    "project_template_id": 1,
    "tag_list": "",
    "tags_data": [

    ],
    "created_at": "2022-02-23T10:03:46-03:00",
    "follower_ids": [

    ],
    "is_assigned": true,
    "team_name": null,
    "subtasks_data": [

    ],
    "responsible_id": "coyote-479",
    "assignments": [
      {
        "id": "92a6f5b72",
        "task_template_id": 15,
        "assignee_id": "coyote-479",
        "team_id": null,
        "assignee_name": "Coyote 479",
        "team_name": null
      }
    ],
    "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/16/prerequisites

Headers

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

Body

{
  "prerequisite": {
    "id": 17
  }
}

cURL

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

Response

Simulated Response

Status

201

Headers

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

Body

{
  "id": 17,
  "title": "Task Template",
  "user_id": "coyote-482",
  "type_id": 2,
  "team_id": null,
  "board_id": null,
  "queue_position": null,
  "project_template_id": 1,
  "tag_list": "",
  "tags_data": [

  ],
  "created_at": "2022-02-23T10:03:48-03:00",
  "follower_ids": [

  ],
  "is_assigned": true,
  "team_name": null,
  "subtasks_data": [

  ],
  "responsible_id": "coyote-482",
  "assignments": [
    {
      "id": "92a6f5b72",
      "task_template_id": 17,
      "assignee_id": "coyote-482",
      "team_id": null,
      "assignee_name": "Coyote 482",
      "team_name": null
    }
  ],
  "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://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

204

Headers

Project Description

PUT

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

Update the project description

Parameters

Name Description type
description required

The text of the description

text

current_editor_id required

ID of user that is editing the description

string

current_editor_name

Name of user that is editing the description

string

edited_at required

Datetime the description has been edited

datetime

locked_at required

Datetime the description has been locked by the current editor

datetime

Request

Route

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

Headers

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

Body

{
  "description": {
    "id": 1,
    "describable_id": 1,
    "describable_type": "Project",
    "description": "My description",
    "created_at": "2022-02-23T10:04:00-03:00",
    "updated_at": "2022-02-23T10:04:00-03:00",
    "edited_at": "2022-02-23T10:04:00-03:00",
    "current_editor_id": null,
    "locked_at": null,
    "was_migrated": null,
    "enterprise_id": 1
  },
  "project_description": {
    "id": null,
    "describable_id": 1,
    "describable_type": "Project",
    "description": "Gorgeous!",
    "created_at": null,
    "updated_at": null,
    "edited_at": null,
    "current_editor_id": null,
    "locked_at": null,
    "was_migrated": null,
    "enterprise_id": null
  }
}

cURL

curl "https://runrun.it/api/v1.0/projects/1/description" -d '{"description":{"id":1,"describable_id":1,"describable_type":"Project","description":"My description","created_at":"2022-02-23T10:04:00-03:00","updated_at":"2022-02-23T10:04:00-03:00","edited_at":"2022-02-23T10:04:00-03:00","current_editor_id":null,"locked_at":null,"was_migrated":null,"enterprise_id":1},"project_description":{"id":null,"describable_id":1,"describable_type":"Project","description":"Gorgeous!","created_at":null,"updated_at":null,"edited_at":null,"current_editor_id":null,"locked_at":null,"was_migrated":null,"enterprise_id":null}}' -X PUT \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": 1,
  "description": "Gorgeous!",
  "current_editor_id": null,
  "current_editor_name": null,
  "edited_at": "2022-02-23T10:04:00-03:00",
  "locked_at": null
}

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://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

200

Headers

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

Body

[
  {
    "id": 1,
    "description": "Cost 1",
    "date": "2018-11-16",
    "amount": 1000.0,
    "project_id": 1,
    "author_name": "Coyote 303",
    "author_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-204/coyote-303/mini.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://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

200

Headers

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

Body

{
  "id": 1,
  "description": "Cost 2",
  "date": "2018-11-16",
  "amount": 1000.0,
  "project_id": 1,
  "author_name": "Coyote 305",
  "author_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-205/coyote-305/mini.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": {
    "description": "Cost 3",
    "date": "2022-02-23",
    "amount": "1000.0"
  }
}

cURL

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

Response

Simulated Response

Status

201

Headers

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

Body

{
  "id": 1,
  "description": "Cost 3",
  "date": "2022-02-23",
  "amount": 1000.0,
  "project_id": 1,
  "author_name": "Coyote 504",
  "author_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-511/coyote-504/mini.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://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

200

Headers

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

Body

[
  {
    "id": 1,
    "name": "Sem grupo",
    "is_default": true,
    "client_id": 1,
    "client_name": "Test client 145",
    "projects_count": 0,
    "time_worked": 0,
    "time_pending_not_assigned": 0,
    "time_pending_queued": 0,
    "time_pending": 0,
    "time_total": 0,
    "time_progress": 0.0,
    "cost_worked": 0.0,
    "cost_pending": 0.0,
    "cost_total": 0.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_days_ago": 0,
    "activities": 0,
    "time_pending_backlog": 0,
    "project_sub_groups": [
      {
        "id": 1,
        "name": null,
        "project_group_id": 1,
        "is_default": true,
        "created_at": "2022-02-23T10:04:12-03:00",
        "updated_at": "2022-02-23T10:04:12-03:00"
      }
    ]
  }
]
POST

/api/v1.0/project_groups/export

Export

Request

Route

POST /api/v1.0/project_groups/export

Headers

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

cURL

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

Response

Simulated Response

Status

200

Headers

Content-Type: application/json
Content-Length: 0

Request

Route

POST /api/v1.0/project_groups/export

Headers

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

Body

{
  "format_type": "xlsx"
}

cURL

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

Response

Simulated Response

Status

200

Headers

Content-Type: application/json
Content-Length: 0

Request

Route

POST /api/v1.0/project_groups/export

Headers

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

Body

{
  "format_type": "csv"
}

cURL

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

Response

Simulated Response

Status

200

Headers

Content-Type: application/json
Content-Length: 0

Request

Route

POST /api/v1.0/project_groups/export

Headers

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

Body

{
  "format_type": "bad_format"
}

cURL

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

Response

Simulated Response

Status

400

Headers

Content-Type: application/json
Content-Length: 0
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://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

200

Headers

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

Body

{
  "id": 2,
  "name": "Project Group 1",
  "is_default": false,
  "client_id": 1,
  "client_name": "Test client 146",
  "projects_count": 0,
  "time_worked": 0,
  "time_pending_not_assigned": 0,
  "time_pending_queued": 0,
  "time_pending": 0,
  "time_total": 0,
  "time_progress": 0.0,
  "cost_worked": 0.0,
  "cost_pending": 0.0,
  "cost_total": 0.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_days_ago": 0,
  "activities": 0,
  "time_pending_backlog": 0,
  "project_sub_groups": [
    {
      "id": 2,
      "name": null,
      "project_group_id": 2,
      "is_default": true,
      "created_at": "2022-02-23T10:04:15-03:00",
      "updated_at": "2022-02-23T10:04:15-03:00"
    }
  ]
}
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": {
    "name": "Project Group 2",
    "is_default": false
  }
}

cURL

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

Response

Simulated Response

Status

201

Headers

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

Body

{
  "id": 2,
  "name": "Project Group 2",
  "is_default": false,
  "client_id": 1,
  "client_name": "Test client 147",
  "projects_count": 0,
  "time_worked": 0,
  "time_pending_not_assigned": 0,
  "time_pending_queued": 0,
  "time_pending": 0,
  "time_total": 0,
  "time_progress": 0.0,
  "cost_worked": 0.0,
  "cost_pending": 0.0,
  "cost_total": 0.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_days_ago": 0,
  "activities": 0,
  "time_pending_backlog": 0,
  "project_sub_groups": [
    {
      "id": 2,
      "name": null,
      "project_group_id": 2,
      "is_default": true,
      "created_at": "2022-02-23T10:04:16-03:00",
      "updated_at": "2022-02-23T10:04:16-03:00"
    }
  ]
}
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://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

200

Headers

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

Body

{
  "id": 2,
  "name": "New Name",
  "is_default": false,
  "client_id": 1,
  "client_name": "Test client 149",
  "projects_count": 0,
  "time_worked": 0,
  "time_pending_not_assigned": 0,
  "time_pending_queued": 0,
  "time_pending": 0,
  "time_total": 0,
  "time_progress": 0.0,
  "cost_worked": 0.0,
  "cost_pending": 0.0,
  "cost_total": 0.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_days_ago": 0,
  "activities": 0,
  "time_pending_backlog": 0,
  "project_sub_groups": [
    {
      "id": 2,
      "name": null,
      "project_group_id": 2,
      "is_default": true,
      "created_at": "2022-02-23T10:04:19-03:00",
      "updated_at": "2022-02-23T10:04:19-03:00"
    }
  ]
}
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://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

204

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://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

200

Headers

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

Body

[
  {
    "id": 3,
    "name": "Project Sub Group 1",
    "is_default": false,
    "project_group_id": 2,
    "client_name": "Test client 152",
    "client_id": 1,
    "project_group_name": "Project Group 7",
    "project_group_is_default": false,
    "projects_count": 0,
    "time_worked": 0,
    "time_pending_not_assigned": 0,
    "time_pending_queued": 0,
    "time_pending": 0,
    "time_total": 0,
    "time_progress": 0.0,
    "cost_worked": 0.0,
    "cost_pending": 0.0,
    "cost_total": 0.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_days_ago": 0,
    "activities": 0,
    "time_pending_backlog": 0
  }
]
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://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

200

Headers

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

Body

[
  {
    "id": 3,
    "name": "Project Sub Group 2",
    "is_default": false,
    "project_group_id": 2,
    "client_name": "Test client 153",
    "client_id": 1,
    "project_group_name": "Project Group 8",
    "project_group_is_default": false,
    "projects_count": 0,
    "time_worked": 0,
    "time_pending_not_assigned": 0,
    "time_pending_queued": 0,
    "time_pending": 0,
    "time_total": 0,
    "time_progress": 0.0,
    "cost_worked": 0.0,
    "cost_pending": 0.0,
    "cost_total": 0.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_days_ago": 0,
    "activities": 0,
    "time_pending_backlog": 0
  }
]
POST

/api/v1.0/project_sub_groups/export

Export

Request

Route

POST /api/v1.0/project_sub_groups/export

Headers

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

cURL

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

Response

Simulated Response

Status

200

Headers

Content-Type: application/json
Content-Length: 0

Request

Route

POST /api/v1.0/project_sub_groups/export

Headers

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

Body

{
  "format_type": "xlsx"
}

cURL

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

Response

Simulated Response

Status

200

Headers

Content-Type: application/json
Content-Length: 0

Request

Route

POST /api/v1.0/project_sub_groups/export

Headers

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

Body

{
  "format_type": "csv"
}

cURL

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

Response

Simulated Response

Status

200

Headers

Content-Type: application/json
Content-Length: 0

Request

Route

POST /api/v1.0/project_sub_groups/export

Headers

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

Body

{
  "format_type": "bad_format"
}

cURL

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

Response

Simulated Response

Status

400

Headers

Content-Type: application/json
Content-Length: 0
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://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

200

Headers

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

Body

{
  "id": 3,
  "name": "Project Sub Group 3",
  "is_default": false,
  "project_group_id": 2,
  "client_name": "Test client 154",
  "client_id": 1,
  "project_group_name": "Project Group 9",
  "project_group_is_default": false,
  "projects_count": 0,
  "time_worked": 0,
  "time_pending_not_assigned": 0,
  "time_pending_queued": 0,
  "time_pending": 0,
  "time_total": 0,
  "time_progress": 0.0,
  "cost_worked": 0.0,
  "cost_pending": 0.0,
  "cost_total": 0.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_days_ago": 0,
  "activities": 0,
  "time_pending_backlog": 0
}
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": {
    "name": "Project Sub Group 4",
    "is_default": false
  }
}

cURL

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

Response

Simulated Response

Status

201

Headers

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

Body

{
  "id": 3,
  "name": "Project Sub Group 4",
  "is_default": false,
  "project_group_id": 2,
  "client_name": "Test client 155",
  "client_id": 1,
  "project_group_name": "Project Group 10",
  "project_group_is_default": false,
  "projects_count": 0,
  "time_worked": 0,
  "time_pending_not_assigned": 0,
  "time_pending_queued": 0,
  "time_pending": 0,
  "time_total": 0,
  "time_progress": 0.0,
  "cost_worked": 0.0,
  "cost_pending": 0.0,
  "cost_total": 0.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_days_ago": 0,
  "activities": 0,
  "time_pending_backlog": 0
}
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://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

200

Headers

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

Body

{
  "id": 3,
  "name": "New Name",
  "is_default": false,
  "project_group_id": 2,
  "client_name": "Test client 158",
  "client_id": 1,
  "project_group_name": "Project Group 12",
  "project_group_is_default": false,
  "projects_count": 0,
  "time_worked": 0,
  "time_pending_not_assigned": 0,
  "time_pending_queued": 0,
  "time_pending": 0,
  "time_total": 0,
  "time_progress": 0.0,
  "cost_worked": 0.0,
  "cost_pending": 0.0,
  "cost_total": 0.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_days_ago": 0,
  "activities": 0,
  "time_pending_backlog": 0
}
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://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

204

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://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

200

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://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

200

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://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

201

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://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

200

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://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

204

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://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

200

Headers

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

Body

[
  {
    "id": 1,
    "name": "Project_A",
    "start_date": null,
    "close_date": null,
    "is_closed": false,
    "client_id": 1,
    "project_group_id": 1,
    "project_sub_group_id": 1,
    "budgeted_cost": 0.0,
    "desired_date": null,
    "created_at": "2022-02-23T10:04:45-03:00",
    "is_public": true,
    "is_shared": false,
    "sharing_details": [

    ],
    "use_new_permissions": true,
    "board_stage_id": null,
    "client_name": "Test client 161",
    "project_group_name": "Sem grupo",
    "project_group_is_default": true,
    "project_sub_group_name": "Sem subgrupo",
    "project_sub_group_is_default": true,
    "tasks_count": 0,
    "tasks_count_progress": 0.0,
    "tasks_not_assigned_count": 0,
    "tasks_queued_count": 0,
    "tasks_working_on_count": 0,
    "tasks_closed_count": 0,
    "task_points_sum": 0,
    "task_points_progress": null,
    "task_points_not_assigned_sum": 0,
    "task_points_queued_sum": 0,
    "task_points_working_on_sum": 0,
    "task_points_closed_sum": 0,
    "time_worked": 0,
    "time_pending": 0,
    "time_pending_not_assigned": 0,
    "time_pending_queued": 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_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_days_ago": 0,
    "activities": 0,
    "estimated_delivery_date": null,
    "board_stage_name": null,
    "board_stage_color": null,
    "activities_7_days_ago": 0,
    "time_pending_backlog": 0,
    "tasks_backlog_count": 0,
    "is_active": true,
    "permissions": [

    ]
  }
]
POST

/api/v1.0/projects/export

Export

Request

Route

POST /api/v1.0/projects/export

Headers

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

Body

{
  "format_type": "xlsx"
}

cURL

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

Response

Simulated Response

Status

200

Headers

Content-Type: application/json
Content-Length: 0

Request

Route

POST /api/v1.0/projects/export

Headers

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

Body

{
  "format_type": "csv"
}

cURL

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

Response

Simulated Response

Status

200

Headers

Content-Type: application/json
Content-Length: 0

Request

Route

POST /api/v1.0/projects/export

Headers

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

Body

{
  "format_type": "bad_format"
}

cURL

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

Response

Simulated Response

Status

400

Headers

Content-Type: application/json
Content-Length: 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://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

200

Headers

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

Body

{
  "id": 1,
  "name": "Project_A",
  "start_date": null,
  "close_date": null,
  "is_closed": false,
  "client_id": 1,
  "project_group_id": 1,
  "project_sub_group_id": 1,
  "budgeted_cost": 0.0,
  "desired_date": null,
  "created_at": "2022-02-23T10:04:55-03:00",
  "is_public": true,
  "is_shared": false,
  "sharing_details": [

  ],
  "use_new_permissions": true,
  "board_stage_id": null,
  "client_name": "Test client 165",
  "project_group_name": "Sem grupo",
  "project_group_is_default": true,
  "project_sub_group_name": "Sem subgrupo",
  "project_sub_group_is_default": true,
  "tasks_count": 0,
  "tasks_count_progress": 0.0,
  "tasks_not_assigned_count": 0,
  "tasks_queued_count": 0,
  "tasks_working_on_count": 0,
  "tasks_closed_count": 0,
  "task_points_sum": 0,
  "task_points_progress": null,
  "task_points_not_assigned_sum": 0,
  "task_points_queued_sum": 0,
  "task_points_working_on_sum": 0,
  "task_points_closed_sum": 0,
  "time_worked": 0,
  "time_pending": 0,
  "time_pending_not_assigned": 0,
  "time_pending_queued": 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_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_days_ago": 0,
  "activities": 0,
  "estimated_delivery_date": null,
  "board_stage_name": null,
  "board_stage_color": null,
  "activities_7_days_ago": 0,
  "time_pending_backlog": 0,
  "tasks_backlog_count": 0,
  "is_active": true,
  "permissions": [

  ]
}
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://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

201

Headers

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

Body

{
  "id": 1,
  "name": "New Project",
  "start_date": null,
  "close_date": null,
  "is_closed": false,
  "client_id": 1,
  "project_group_id": 1,
  "project_sub_group_id": 1,
  "budgeted_cost": 0.0,
  "desired_date": null,
  "created_at": "2022-02-23T10:04:57-03:00",
  "is_public": true,
  "is_shared": false,
  "sharing_details": [

  ],
  "use_new_permissions": true,
  "board_stage_id": null,
  "client_name": "Test client 166",
  "project_group_name": "Sem grupo",
  "project_group_is_default": true,
  "project_sub_group_name": "Sem subgrupo",
  "project_sub_group_is_default": true,
  "tasks_count": 0,
  "tasks_count_progress": 0.0,
  "tasks_not_assigned_count": 0,
  "tasks_queued_count": 0,
  "tasks_working_on_count": 0,
  "tasks_closed_count": 0,
  "task_points_sum": 0,
  "task_points_progress": null,
  "task_points_not_assigned_sum": 0,
  "task_points_queued_sum": 0,
  "task_points_working_on_sum": 0,
  "task_points_closed_sum": 0,
  "time_worked": 0,
  "time_pending": 0,
  "time_pending_not_assigned": 0,
  "time_pending_queued": 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_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_days_ago": 0,
  "activities": 0,
  "estimated_delivery_date": null,
  "board_stage_name": null,
  "board_stage_color": null,
  "activities_7_days_ago": 0,
  "time_pending_backlog": 0,
  "tasks_backlog_count": 0,
  "is_active": true,
  "permissions": [
    {
      "id": 1,
      "resource_id": "coyote-536",
      "resource_type": "User",
      "context_id": 1,
      "context_type": "Project",
      "role": null,
      "created_at": "2022-02-23T10:04:57-03:00"
    }
  ]
}
POST

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

Share the project

Share the project with guests.

Parameters

Name Description type
id required

ID of project

integer

comment

string

guests_params

List of objects with guest data

array

sharing_details

List of optional information to be shared. Options: "tasks", "desired_date", "board_stage", "time_progress", "tasks_count_progress"

array

Request

Route

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

Headers

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

Body

{
  "sharing_details": [
    "desired_date"
  ],
  "guests_params": [
    {
      "email": "guest1@email.com"
    },
    {
      "email": "guest2@email.com"
    }
  ]
}

cURL

curl "https://runrun.it/api/v1.0/projects/1/share" -d '{"sharing_details":["desired_date"],"guests_params":[{"email":"guest1@email.com"},{"email":"guest2@email.com"}]}' -X POST \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": 1,
  "name": "Project_A",
  "start_date": null,
  "close_date": null,
  "is_closed": false,
  "client_id": 1,
  "project_group_id": 1,
  "project_sub_group_id": 1,
  "budgeted_cost": 0.0,
  "desired_date": null,
  "created_at": "2022-04-14T18:01:00-03:00",
  "is_public": true,
  "is_shared": true,
  "sharing_details": [
    "desired_date"
  ],
  "use_new_permissions": true,
  "board_stage_id": null,
  "client_name": "Test client 170",
  "project_group_name": "Sem grupo",
  "project_group_is_default": true,
  "project_sub_group_name": "Sem subgrupo",
  "project_sub_group_is_default": true,
  "tasks_count": 0,
  "tasks_count_progress": 0.0,
  "tasks_not_assigned_count": 0,
  "tasks_queued_count": 0,
  "tasks_working_on_count": 0,
  "tasks_closed_count": 0,
  "task_points_sum": 0,
  "task_points_progress": null,
  "task_points_not_assigned_sum": 0,
  "task_points_queued_sum": 0,
  "task_points_working_on_sum": 0,
  "task_points_closed_sum": 0,
  "time_worked": 0,
  "time_pending": 0,
  "time_pending_not_assigned": 0,
  "time_pending_queued": 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_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_days_ago": 0,
  "activities": 0,
  "estimated_delivery_date": null,
  "board_stage_name": null,
  "board_stage_color": null,
  "activities_7_days_ago": 0,
  "time_pending_backlog": 0,
  "tasks_backlog_count": 0,
  "is_active": true,
  "permissions": [

  ]
}

Request

Route

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

Headers

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

Body

{
  "sharing_details": [
    "desired_date",
    "time_progress"
  ],
  "guests_params": [
    {
      "email": "guest2@email.com"
    },
    {
      "email": "guest3@email.com"
    }
  ]
}

cURL

curl "https://runrun.it/api/v1.0/projects/1/share" -d '{"sharing_details":["desired_date","time_progress"],"guests_params":[{"email":"guest2@email.com"},{"email":"guest3@email.com"}]}' -X POST \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": 1,
  "name": "Project_A",
  "start_date": null,
  "close_date": null,
  "is_closed": false,
  "client_id": 1,
  "project_group_id": 1,
  "project_sub_group_id": 1,
  "budgeted_cost": 0.0,
  "desired_date": null,
  "created_at": "2022-04-14T18:01:00-03:00",
  "is_public": true,
  "is_shared": true,
  "sharing_details": [
    "desired_date",
    "time_progress"
  ],
  "use_new_permissions": true,
  "board_stage_id": null,
  "client_name": "Test client 170",
  "project_group_name": "Sem grupo",
  "project_group_is_default": true,
  "project_sub_group_name": "Sem subgrupo",
  "project_sub_group_is_default": true,
  "tasks_count": 0,
  "tasks_count_progress": 0.0,
  "tasks_not_assigned_count": 0,
  "tasks_queued_count": 0,
  "tasks_working_on_count": 0,
  "tasks_closed_count": 0,
  "task_points_sum": 0,
  "task_points_progress": null,
  "task_points_not_assigned_sum": 0,
  "task_points_queued_sum": 0,
  "task_points_working_on_sum": 0,
  "task_points_closed_sum": 0,
  "time_worked": 0,
  "time_pending": 0,
  "time_pending_not_assigned": 0,
  "time_pending_queued": 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_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_days_ago": 0,
  "activities": 0,
  "estimated_delivery_date": null,
  "board_stage_name": null,
  "board_stage_color": null,
  "activities_7_days_ago": 0,
  "time_pending_backlog": 0,
  "tasks_backlog_count": 0,
  "is_active": true,
  "permissions": [

  ]
}

Request

Route

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

Headers

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

Body

{
  "sharing_details": [

  ],
  "guests_params": [

  ]
}

cURL

curl "https://runrun.it/api/v1.0/projects/1/share" -d '{"sharing_details":[],"guests_params":[]}' -X POST \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": 1,
  "name": "Project_A",
  "start_date": null,
  "close_date": null,
  "is_closed": false,
  "client_id": 1,
  "project_group_id": 1,
  "project_sub_group_id": 1,
  "budgeted_cost": 0.0,
  "desired_date": null,
  "created_at": "2022-04-14T18:01:00-03:00",
  "is_public": true,
  "is_shared": true,
  "sharing_details": [

  ],
  "use_new_permissions": true,
  "board_stage_id": null,
  "client_name": "Test client 170",
  "project_group_name": "Sem grupo",
  "project_group_is_default": true,
  "project_sub_group_name": "Sem subgrupo",
  "project_sub_group_is_default": true,
  "tasks_count": 0,
  "tasks_count_progress": 0.0,
  "tasks_not_assigned_count": 0,
  "tasks_queued_count": 0,
  "tasks_working_on_count": 0,
  "tasks_closed_count": 0,
  "task_points_sum": 0,
  "task_points_progress": null,
  "task_points_not_assigned_sum": 0,
  "task_points_queued_sum": 0,
  "task_points_working_on_sum": 0,
  "task_points_closed_sum": 0,
  "time_worked": 0,
  "time_pending": 0,
  "time_pending_not_assigned": 0,
  "time_pending_queued": 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_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_days_ago": 0,
  "activities": 0,
  "estimated_delivery_date": null,
  "board_stage_name": null,
  "board_stage_color": null,
  "activities_7_days_ago": 0,
  "time_pending_backlog": 0,
  "tasks_backlog_count": 0,
  "is_active": true,
  "permissions": [

  ]
}
POST

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

Unshare the project

Parameters

Name Description type
id required

ID of project

integer

Request

Route

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

Headers

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

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": 1,
  "name": "Project_A",
  "start_date": null,
  "close_date": null,
  "is_closed": false,
  "client_id": 1,
  "project_group_id": 1,
  "project_sub_group_id": 1,
  "budgeted_cost": 0.0,
  "desired_date": null,
  "created_at": "2022-04-14T18:01:05-03:00",
  "is_public": true,
  "is_shared": false,
  "sharing_details": [

  ],
  "use_new_permissions": true,
  "board_stage_id": null,
  "client_name": "Test client 171",
  "project_group_name": "Sem grupo",
  "project_group_is_default": true,
  "project_sub_group_name": "Sem subgrupo",
  "project_sub_group_is_default": true,
  "tasks_count": 0,
  "tasks_count_progress": 0.0,
  "tasks_not_assigned_count": 0,
  "tasks_queued_count": 0,
  "tasks_working_on_count": 0,
  "tasks_closed_count": 0,
  "task_points_sum": 0,
  "task_points_progress": null,
  "task_points_not_assigned_sum": 0,
  "task_points_queued_sum": 0,
  "task_points_working_on_sum": 0,
  "task_points_closed_sum": 0,
  "time_worked": 0,
  "time_pending": 0,
  "time_pending_not_assigned": 0,
  "time_pending_queued": 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_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_days_ago": 0,
  "activities": 0,
  "estimated_delivery_date": null,
  "board_stage_name": null,
  "board_stage_color": null,
  "activities_7_days_ago": 0,
  "time_pending_backlog": 0,
  "tasks_backlog_count": 0,
  "is_active": true,
  "permissions": [

  ]
}

Time Worked

POST

/api/v1.0/reports/time_worked/export

Export

Request

Route

POST /api/v1.0/reports/time_worked/export

Headers

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

Body

{
  "format_type": "xlsx"
}

cURL

curl "https://runrun.it/api/v1.0/reports/time_worked/export" -d '{"format_type":"xlsx"}' -X POST \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

200

Headers

Content-Type: application/json
Content-Length: 0
GET

/api/v1.0/reports/time_worked

List all time worked grouped and filtered by parameters

Returns a time worked list grouped by the provided group_by params. More than one attribute can be used for grouping.

Providing a client_id, project_id, project_group_id, project_subgroup_id, tag_list or type_id will return a filtered list by the given parameter.

Parameters

Name Description type default
include_capacity

Include capacity

boolean

include_untracked

Include untracked

boolean

include_others

Include others

boolean

true

expand_others

Expand others field to a non-aggregate

boolean

group_by

Attributes to group by

text

period_type

Period type. Must be one of the following: last_seven_days, current_week, last_fifteen_days, last_thirty_days, current_month, last_ninety_days, current_quarter, last_one_year, custom_range

text

last_seven_days

period_start

Period start. Only used if period_type is 'custom_range'

date

period_end

Period end. Only used if period_type is 'custom_range'

date

period_unit

Period unit. Must be one of the following: day, week, month or year

text

day

client_id

IDs of clients, separated by comma

text

project_id

IDs of projects, separated by comma

text

project_group_id

ID of project group

text

project_subgroup_id

ID of project subgroup

text

tag_list

List of task tags, separated by comma

text

type_id

IDs of task types, separated by comma

text

team_id

IDs of teams, separated by comma

text

user_id

IDs of users, separated by comma

text

Request

Route

GET /api/v1.0/reports/time_worked?include_capacity=true&include_untracked=true&group_by=date%2Cproject_id&project_id=1

Headers

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

Query Parameters

include_capacity=true
include_untracked=true
group_by=date,project_id
project_id=1

cURL

curl "https://runrun.it/api/v1.0/reports/time_worked?include_capacity=true&include_untracked=true&group_by=date%2Cproject_id&project_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
meta Represents the parameters used for building the response Object
result Time Worked filtered and/or grouped by the given parameters Array of Objects
other Represents all the *other* time worked not contained on the result Array of Objects
capacity Total time on users' workweek Array of Objects
untracked Time not tracked by the system Array of Objects

Status

200

Headers

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

Body

{
  "meta": {
    "period_start": "2018-01-31",
    "period_end": "2018-02-06",
    "unit": "day"
  },
  "result": [
    {
      "date": "2018-02-05",
      "project_id": 1,
      "project_name": "Test project 151",
      "project_sub_group_id": 1,
      "project_sub_group_name": null,
      "project_group_id": 1,
      "project_group_name": null,
      "client_id": 1,
      "client_name": "Test client 182",
      "automatic_time": 0,
      "manual_time": 72000,
      "time": 72000
    }
  ],
  "others": [
    {
      "date": "2018-02-05",
      "time": 10800
    }
  ],
  "capacity": [
    {
      "date": "2018-01-31",
      "time": 28800
    },
    {
      "date": "2018-02-01",
      "time": 28800
    },
    {
      "date": "2018-02-02",
      "time": 28800
    },
    {
      "date": "2018-02-03",
      "time": 0
    },
    {
      "date": "2018-02-04",
      "time": 0
    },
    {
      "date": "2018-02-05",
      "time": 28800
    },
    {
      "date": "2018-02-06",
      "time": 0
    }
  ],
  "untracked": [
    {
      "date": "2018-02-05",
      "time": 0
    },
    {
      "date": "2018-01-31",
      "time": 28800
    },
    {
      "date": "2018-02-01",
      "time": 28800
    },
    {
      "date": "2018-02-02",
      "time": 28800
    },
    {
      "date": "2018-02-03",
      "time": 0
    },
    {
      "date": "2018-02-04",
      "time": 0
    },
    {
      "date": "2018-02-06",
      "time": 0
    }
  ]
}

Tags

GET

/api/v1.0/tags

Query tags

Parameters

Name Description type
search_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.

string

Request

Route

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

Headers

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

Query Parameters

search_term=tag

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

[
  {
    "name": "tag1"
  },
  {
    "name": "tag2"
  },
  {
    "name": "tag3"
  }
]

TaskAssignments

DELETE

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

Destroy a task assignment for another user

Destroy a task assignment.

Parameters

Name Description type default
id

ID of assignment

string

task_id required

ID of task

integer

destroy_worked_time

boolean

Request

Route

DELETE /api/v1.0/tasks/1/assignments/92a6f5b72

Headers

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

Body

{
  "destroy_worked_time": false
}

cURL

curl "https://runrun.it/api/v1.0/tasks/1/assignments/92a6f5b72" -d '{"destroy_worked_time":false}' -X DELETE \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

204

Headers

POST

/api/v1.0/tasks/:task_id/assignments/: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 assignment

string

task_id required

ID of task

integer

Request

Route

POST /api/v1.0/tasks/1/assignments/49537adb9/play

Headers

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

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "49537adb9",
  "task_id": 1,
  "assignee_id": "coyote-605",
  "team_id": null,
  "assignee_name": "Coyote 605",
  "team_name": null,
  "queue_position": 1,
  "priority": 1,
  "current_estimate_seconds": 3600,
  "time_worked": 0,
  "estimated_start_date": null,
  "estimate_updated": false,
  "start_date": "2022-02-23T10:06:33-03:00",
  "close_date": null,
  "is_closed": false,
  "reestimate_count": 0,
  "is_working_on": true,
  "automatic_time_worked_updated_at": "2022-02-23T10:06:33-03:00",
  "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-598/coyote-605/mini.png",
  "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-598/coyote-605/regular.png",
  "time_worked_not_persisted": 0
}
POST

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

Pause a task assignment

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 assignment

string

task_id required

ID of task

integer

Request

Route

POST /api/v1.0/tasks/1/assignments/49537adb9/pause

Headers

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

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "49537adb9",
  "task_id": 1,
  "assignee_id": "coyote-608",
  "team_id": null,
  "assignee_name": "Coyote 608",
  "team_name": null,
  "queue_position": 1,
  "priority": 1,
  "current_estimate_seconds": 3600,
  "time_worked": 0,
  "estimated_start_date": "2022-02-23T10:06:36-03:00",
  "estimate_updated": false,
  "start_date": "2022-02-23T10:06:35-03:00",
  "close_date": null,
  "is_closed": false,
  "reestimate_count": 0,
  "is_working_on": false,
  "automatic_time_worked_updated_at": "2022-02-23T10:06:36-03:00",
  "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-600/coyote-608/mini.png",
  "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-600/coyote-608/regular.png",
  "time_worked_not_persisted": 0
}
POST

/api/v1.0/tasks/:task_id/assignments/:id/deliver

Deliver a task assignment

Deliver a task.

The task is eligible to be delivered if:

  • it's not already delivered
  • it does not have any open prerequisite tasks

Parameters

Name Description type
id

ID of assignment

string

task_id required

ID of task

integer

Request

Route

POST /api/v1.0/tasks/1/assignments/49537adb9/deliver

Headers

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

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "49537adb9",
  "task_id": 1,
  "assignee_id": "coyote-611",
  "team_id": null,
  "assignee_name": "Coyote 611",
  "team_name": null,
  "queue_position": null,
  "priority": null,
  "current_estimate_seconds": 3600,
  "time_worked": 0,
  "estimated_start_date": null,
  "estimate_updated": true,
  "start_date": "2022-02-23T10:06:38-03:00",
  "close_date": "2022-02-23T10:06:38-03:00",
  "is_closed": true,
  "reestimate_count": 0,
  "is_working_on": false,
  "automatic_time_worked_updated_at": "2022-02-23T10:06:38-03:00",
  "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-602/coyote-611/mini.png",
  "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-602/coyote-611/regular.png",
  "time_worked_not_persisted": 0
}
POST

/api/v1.0/tasks/:task_id/assignments/: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 assignment

string

task_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/1/assignments/49537adb9/reopen

Headers

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

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "49537adb9",
  "task_id": 1,
  "assignee_id": "coyote-614",
  "team_id": null,
  "assignee_name": "Coyote 614",
  "team_name": null,
  "queue_position": 1,
  "priority": 1,
  "current_estimate_seconds": 3600,
  "time_worked": 0,
  "estimated_start_date": null,
  "estimate_updated": false,
  "start_date": null,
  "close_date": null,
  "is_closed": false,
  "reestimate_count": 0,
  "is_working_on": false,
  "automatic_time_worked_updated_at": "2022-02-23T10:06:40-03:00",
  "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-604/coyote-614/mini.png",
  "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-604/coyote-614/regular.png",
  "time_worked_not_persisted": 0
}
POST

/api/v1.0/tasks/:task_id/assignments/:id/reposition

Reposition a Task

Parameters

Name Description type
id required

ID of assignment

string

queue_position required

The new queue position on assignee user's task list

integer

Request

Route

POST /api/v1.0/tasks/3/assignments/dbfa7092b/reposition

Headers

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

Body

{
  "queue_position": 2
}

cURL

curl "https://runrun.it/api/v1.0/tasks/3/assignments/dbfa7092b/reposition" -d '{"queue_position":2}' -X POST \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "dbfa7092b",
  "task_id": 3,
  "assignee_id": "coyote-617",
  "team_id": null,
  "assignee_name": "Coyote 617",
  "team_name": null,
  "queue_position": 2,
  "priority": 2,
  "current_estimate_seconds": 3600,
  "time_worked": 0,
  "estimated_start_date": null,
  "estimate_updated": false,
  "start_date": null,
  "close_date": null,
  "is_closed": false,
  "reestimate_count": 0,
  "is_working_on": false,
  "automatic_time_worked_updated_at": "2022-02-23T10:06:43-03:00",
  "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-606/coyote-617/mini.png",
  "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-606/coyote-617/regular.png",
  "time_worked_not_persisted": 0
}
POST

/api/v1.0/tasks/:task_id/assignments/:id/reestimate

Reestimate a task assignment

Parameters

Name Description type
id required

ID of assignment

string

task_id required

ID of task

integer

work_seconds required

Request

Route

POST /api/v1.0/tasks/1/assignments/49537adb9/reestimate

Headers

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

Body

{
  "work_seconds": 118800
}

cURL

curl "https://runrun.it/api/v1.0/tasks/1/assignments/49537adb9/reestimate" -d '{"work_seconds":118800}' -X POST \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "49537adb9",
  "task_id": 1,
  "assignee_id": "coyote-620",
  "team_id": null,
  "assignee_name": "Coyote 620",
  "team_name": null,
  "queue_position": 1,
  "priority": 1,
  "current_estimate_seconds": 118800,
  "time_worked": 0,
  "estimated_start_date": null,
  "estimate_updated": false,
  "start_date": null,
  "close_date": null,
  "is_closed": false,
  "reestimate_count": 1,
  "is_working_on": false,
  "automatic_time_worked_updated_at": "2022-02-23T10:06:46-03:00",
  "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-608/coyote-620/mini.png",
  "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-608/coyote-620/regular.png",
  "time_worked_not_persisted": 0
}

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://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

200

Headers

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

Body

{
  "id": 1,
  "description": "Awesome!",
  "current_editor_id": null,
  "current_editor_name": null,
  "edited_at": "2022-02-23T10:06:48-03:00",
  "locked_at": null
}
PUT

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

Update the task description

Update a task description.

Parameters

Name Description type
description required

The text of the description

text

current_editor_id required

ID of user that is editing the description

string

current_editor_name

Name of user that is editing the description

string

edited_at required

Datetime the description has been edited

datetime

locked_at required

Datetime the description has been locked by the current editor

datetime

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": {
    "id": null,
    "description": "Gorgeous!",
    "task_id": 1,
    "created_at": null,
    "updated_at": null,
    "current_editor_id": null,
    "edited_at": null,
    "locked_at": null,
    "was_migrated": null,
    "enterprise_id": null
  }
}

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": 1,
  "description": "Gorgeous!",
  "current_editor_id": null,
  "current_editor_name": null,
  "edited_at": "2022-02-23T10:06:50-03:00",
  "locked_at": null
}

Task Statuses

GET

/api/v1.0/task_statuses

List all Task Statuses

Request

Route

GET /api/v1.0/task_statuses

Headers

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

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

[
  {
    "id": 3,
    "name": "Board Stage 502",
    "stage_group": "closed",
    "board_id": 1,
    "position": 1,
    "is_following": false,
    "use_latency_time": true,
    "use_scrum_points": true,
    "is_default": false,
    "is_delivered": false,
    "status_group": "assigned"
  },
  {
    "id": 2,
    "name": "Board Stage 501",
    "stage_group": "opened",
    "board_id": 1,
    "position": 2,
    "is_following": false,
    "use_latency_time": true,
    "use_scrum_points": true,
    "is_default": false,
    "is_delivered": false,
    "status_group": "assigned"
  },
  {
    "id": 1,
    "name": "Board Stage 500",
    "stage_group": "opened",
    "board_id": 1,
    "position": 1,
    "is_following": false,
    "use_latency_time": true,
    "use_scrum_points": true,
    "is_default": false,
    "is_delivered": false,
    "status_group": "assigned"
  }
]
GET

/api/v1.0/task_statuses/:id

Show a Task Status

Request

Route

GET /api/v1.0/task_statuses/1

Headers

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

cURL

curl "https://runrun.it/api/v1.0/task_statuses/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 Board Stage integer
name Display name of Board Stage string
stage_group Group of stage ('opened' or 'closed') enum
board_id ID of Board integer
position Position of stage in Board integer
is_following Returns 'true' if user follows the Board Stage boolean
use_latency_time Returns 'true' if board stage latency time is being calculated boolean
use_scrum_points Returns 'true' if task points should be shown boolean
user_settings User settings for board stage hash
is_default [Deprecated] Is a default status created by the system boolean
is_delivered [Deprecated] Use status_group boolean
status_group [Deprecated] Use stage_group enum

Status

200

Headers

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

Body

{
  "id": 1,
  "name": "Board Stage 503",
  "stage_group": "opened",
  "board_id": 1,
  "position": 1,
  "is_following": false,
  "use_latency_time": true,
  "use_scrum_points": true,
  "is_default": false,
  "is_delivered": false,
  "status_group": "assigned"
}
POST

/api/v1.0/task_statuses

Create a Task Status

Create a task status. Only account administrators can perform this action.

Parameters

Name Description type
task_status[name] required

Display name of Task Status

string

Request

Route

POST /api/v1.0/task_statuses

Headers

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

Body

{
  "task_status": {
    "name": "Task Status 8"
  }
}

cURL

curl "https://runrun.it/api/v1.0/task_statuses" -d '{"task_status":{"name":"Task Status 8"}}' -X POST \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

201

Headers

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

Body

{
  "id": 3,
  "name": "Task Status 8",
  "is_default": false,
  "status_group": "assigned",
  "is_delivered": false
}
PUT

/api/v1.0/task_statuses/:id

Update a Task Status

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

Parameters

Name Description type
task_statuses[name]

Display name of Task Status

string

Request

Route

PUT /api/v1.0/task_statuses/3

Headers

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

Body

{
  "task_status": {
    "name": "Release pending"
  }
}

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": 3,
  "name": "Release pending",
  "is_default": false,
  "status_group": "assigned",
  "is_delivered": false
}
DELETE

/api/v1.0/task_statuses/:id

Destroy a Task Status

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

Request

Route

DELETE /api/v1.0/task_statuses/1

Headers

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

Body

{
  "destroy": true
}

cURL

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

Response

Simulated Response

Status

200

Headers

Content-Type: application/json
Content-Length: 0

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://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

200

Headers

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

Body

[
  {
    "id": 27,
    "title": "Task Template",
    "user_id": "coyote-687",
    "type_id": 2,
    "team_id": null,
    "board_id": null,
    "queue_position": null,
    "project_template_id": 1,
    "tag_list": "",
    "tags_data": [

    ],
    "created_at": "2022-02-23T10:07:45-03:00",
    "follower_ids": [

    ],
    "is_assigned": true,
    "team_name": null,
    "subtasks_data": [

    ],
    "responsible_id": "coyote-687",
    "assignments": [
      {
        "id": "92a6f5b72",
        "task_template_id": 27,
        "assignee_id": "coyote-687",
        "team_id": null,
        "assignee_name": "Coyote 687",
        "team_name": null
      }
    ],
    "workflow_id": null
  },
  {
    "id": 26,
    "title": "Task Template",
    "user_id": "coyote-687",
    "type_id": 1,
    "team_id": null,
    "board_id": null,
    "queue_position": null,
    "project_template_id": 1,
    "tag_list": "",
    "tags_data": [

    ],
    "created_at": "2022-02-23T10:07:45-03:00",
    "follower_ids": [

    ],
    "is_assigned": true,
    "team_name": null,
    "subtasks_data": [

    ],
    "responsible_id": "coyote-687",
    "assignments": [
      {
        "id": "49537adb9",
        "task_template_id": 26,
        "assignee_id": "coyote-687",
        "team_id": null,
        "assignee_name": "Coyote 687",
        "team_name": null
      }
    ],
    "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/28

Headers

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

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": 28,
  "title": "Task Template",
  "user_id": "coyote-688",
  "type_id": 1,
  "team_id": null,
  "board_id": null,
  "queue_position": null,
  "project_template_id": 1,
  "tag_list": "",
  "tags_data": [

  ],
  "created_at": "2022-02-23T10:07:46-03:00",
  "follower_ids": [

  ],
  "is_assigned": true,
  "team_name": null,
  "subtasks_data": [

  ],
  "responsible_id": "coyote-688",
  "assignments": [
    {
      "id": "49537adb9",
      "task_template_id": 28,
      "assignee_id": "coyote-688",
      "team_id": null,
      "assignee_name": "Coyote 688",
      "team_name": null
    }
  ],
  "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

type_id required

ID of task template type

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": {
    "type_id": 1,
    "title": "Task Template",
    "tag_list": [

    ],
    "assignments": [
      {
        "assignee_id": "coyote-689",
        "team_id": 1
      }
    ],
    "subtasks_data": [
      {
        "title": "Subtarefa 1",
        "desired_date": "2021-02-21 10:30 0300",
        "assignments_data": [
          {
            "assignee_id": "coyote-689",
            "team_id": 1
          }
        ]
      }
    ]
  }
}

cURL

curl "https://runrun.it/api/v1.0/project_templates/1/task_templates" -d '{"task_template":{"type_id":1,"title":"Task Template","tag_list":[],"assignments":[{"assignee_id":"coyote-689","team_id":1}],"subtasks_data":[{"title":"Subtarefa 1","desired_date":"2021-02-21 10:30 0300","assignments_data":[{"assignee_id":"coyote-689","team_id":1}]}]}}' -X POST \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

201

Headers

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

Body

{
  "id": 1,
  "title": "Task Template",
  "user_id": "coyote-689",
  "type_id": 1,
  "team_id": 1,
  "board_id": null,
  "queue_position": 1,
  "project_template_id": 1,
  "tag_list": "",
  "tags_data": [

  ],
  "created_at": "2022-02-23T10:07:48-03:00",
  "follower_ids": [

  ],
  "is_assigned": true,
  "team_name": null,
  "subtasks_data": [
    {
      "title": "Subtarefa 1",
      "desired_date": "2021-02-21 10:30 0300",
      "assignments_data": [
        {
          "assignee_id": "coyote-689",
          "assignee_name": "Coyote 689",
          "avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-661/coyote-689/mini.png",
          "team_id": 1,
          "team_name": "Test team 49"
        }
      ]
    }
  ],
  "responsible_id": "coyote-689",
  "assignments": [
    {
      "id": "49537adb9",
      "task_template_id": 1,
      "assignee_id": "coyote-689",
      "team_id": 1,
      "assignee_name": "Coyote 689",
      "team_name": "Test team 49"
    }
  ],
  "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/30

Headers

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

Body

{
  "task_template": {
    "title": "New Title",
    "type_id": 1,
    "assignments": [
      {
        "assignee_id": "coyote-692",
        "team_id": 1
      }
    ],
    "subtasks_data": [
      {
        "title": "Subtarefa 1",
        "desired_date": "2021-02-21 10:30 0300",
        "assignments_data": [
          {
            "assignee_id": "coyote-691",
            "team_id": 1
          }
        ]
      }
    ]
  }
}

cURL

curl "https://runrun.it/api/v1.0/project_templates/1/task_templates/30" -d '{"task_template":{"title":"New Title","type_id":1,"assignments":[{"assignee_id":"coyote-692","team_id":1}],"subtasks_data":[{"title":"Subtarefa 1","desired_date":"2021-02-21 10:30 0300","assignments_data":[{"assignee_id":"coyote-691","team_id":1}]}]}}' -X PUT \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": 30,
  "title": "New Title",
  "user_id": "coyote-691",
  "type_id": 1,
  "team_id": 1,
  "board_id": null,
  "queue_position": null,
  "project_template_id": 1,
  "tag_list": "",
  "tags_data": [

  ],
  "created_at": "2022-02-23T10:07:49-03:00",
  "follower_ids": [

  ],
  "is_assigned": true,
  "team_name": null,
  "subtasks_data": [
    {
      "title": "Subtarefa 1",
      "desired_date": "2021-02-21 10:30 0300",
      "assignments_data": [
        {
          "assignee_id": "coyote-691",
          "assignee_name": "Coyote 691",
          "avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-662/coyote-691/mini.png",
          "team_id": 1,
          "team_name": "Test team 50"
        }
      ]
    }
  ],
  "responsible_id": "coyote-692",
  "assignments": [
    {
      "id": "92a6f5b72",
      "task_template_id": 30,
      "assignee_id": "coyote-692",
      "team_id": 1,
      "assignee_name": "Coyote 692",
      "team_name": "Test team 50"
    }
  ],
  "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://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

204

Headers

TaskType

GET

/api/v1.0/task_types

List all task types

List all task types that the current user can view.

Request

Route

GET /api/v1.0/task_types

Headers

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

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

[
  {
    "id": 1,
    "name": "TaskType1",
    "is_visible": true,
    "standard_effort": "01:00",
    "standard_effort_time": 3600,
    "avg_delivery": 0,
    "color": "FFFFFF",
    "is_public": true,
    "is_default": false,
    "permissions": [

    ]
  },
  {
    "id": 2,
    "name": "TaskType2",
    "is_visible": true,
    "standard_effort": "01:00",
    "standard_effort_time": 3600,
    "avg_delivery": 0,
    "color": "FFFFFF",
    "is_public": true,
    "is_default": false,
    "permissions": [

    ]
  },
  {
    "id": 3,
    "name": "TaskType3",
    "is_visible": true,
    "standard_effort": "01:00",
    "standard_effort_time": 3600,
    "avg_delivery": 0,
    "color": "FFFFFF",
    "is_public": true,
    "is_default": false,
    "permissions": [

    ]
  }
]
GET

/api/v1.0/task_types/:id

Show a task type

Parameters

Name Description type
id required

Id of the type

integer

Request

Route

GET /api/v1.0/task_types/1

Headers

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

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": 1,
  "name": "TaskType1",
  "is_visible": true,
  "standard_effort": "01:00",
  "standard_effort_time": 3600,
  "avg_delivery": 0,
  "color": "FFFFFF",
  "is_public": true,
  "is_default": false,
  "permissions": [

  ]
}
POST

/api/v1.0/task_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/task_types

Headers

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

Body

{
  "task_type": {
    "name": "TaskType1",
    "is_visible": true,
    "standard_effort": "03:00",
    "color": "FFFFFF"
  }
}

cURL

curl "https://runrun.it/api/v1.0/task_types" -d '{"task_type":{"name":"TaskType1","is_visible":true,"standard_effort":"03:00","color":"FFFFFF"}}' -X POST \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

201

Headers

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

Body

{
  "id": 1,
  "name": "TaskType1",
  "is_visible": true,
  "standard_effort": "03:00",
  "standard_effort_time": 10800,
  "avg_delivery": 0,
  "color": "FFFFFF",
  "is_public": true,
  "is_default": false,
  "permissions": [
    {
      "id": 1,
      "resource_id": "coyote-696",
      "resource_type": "User",
      "context_id": 1,
      "context_type": "TaskType",
      "role": null,
      "created_at": "2022-02-23T10:07:55-03:00"
    }
  ]
}
PUT

/api/v1.0/task_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/task_types/1

Headers

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

Body

{
  "task_type": {
    "name": "TaskType2",
    "is_visible": false,
    "standard_effort": "04:00"
  }
}

cURL

curl "https://runrun.it/api/v1.0/task_types/1" -d '{"task_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

200

Headers

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

Body

{
  "id": 1,
  "name": "TaskType2",
  "is_visible": false,
  "standard_effort": "04:00",
  "standard_effort_time": 14400,
  "avg_delivery": 0,
  "color": "FFFFFF",
  "is_public": true,
  "is_default": false,
  "permissions": [

  ]
}

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/1/followers

Headers

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

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

[
  {
    "id": "coyote-699",
    "name": "Coyote 699",
    "email": "coyote685@acme.foo",
    "avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-669/coyote-699/mini.png",
    "avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-669/coyote-699/regular.png",
    "cost_hour": 0.0,
    "is_master": true,
    "is_manager": false,
    "is_auditor": false,
    "can_create_client_project_and_task_types": true,
    "can_create_boards": true,
    "is_blocked_on_mobile": false,
    "bypass_block_by_time_worked": false,
    "time_zone": "America/Sao_Paulo",
    "position": null,
    "on_vacation": false,
    "birthday": null,
    "phone": null,
    "gender": null,
    "marital_status": null,
    "created_at": "2022-02-23T10:07:59-03:00",
    "in_company_since": null,
    "is_certified": false,
    "language": "pt-BR",
    "alt_id": "b195a9f7c5fd773317de248822ee6e90",
    "oid": "49537adb9",
    "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",
        "work_time": 0
      },
      {
        "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",
        "work_time": 28800
      },
      {
        "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",
        "work_time": 28800
      },
      {
        "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",
        "work_time": 28800
      },
      {
        "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",
        "work_time": 28800
      },
      {
        "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",
        "work_time": 28800
      },
      {
        "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",
        "work_time": 0
      }
    ],
    "is_mensurable": true,
    "time_tracking_mode": "smart",
    "blocked_by_time_worked_at": null,
    "demanders_count": 0,
    "partners_count": 0,
    "has_all_users_as_partners": false,
    "has_all_users_as_demanders": false,
    "password_updated_at": null,
    "password_expired_at": null,
    "shift_work_time_per_week": 144000,
    "team_ids": [

    ],
    "led_team_ids": [

    ],
    "skip_time_adjust_on_task_assignment_deliver": false,
    "theme": "light",
    "task_list_background_image_url": null
  }
]
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/1/followers

Headers

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

Body

{
  "id": "coyote-701"
}

cURL

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

Response

Simulated Response

Status

201

Headers

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

Body

{
  "id": "coyote-701",
  "name": "Coyote 701",
  "email": "coyote687@acme.foo",
  "avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-670/coyote-701/mini.png",
  "avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-670/coyote-701/regular.png",
  "cost_hour": 0.0,
  "is_master": false,
  "is_manager": false,
  "is_auditor": false,
  "can_create_client_project_and_task_types": false,
  "can_create_boards": true,
  "is_blocked_on_mobile": false,
  "bypass_block_by_time_worked": false,
  "time_zone": "America/Sao_Paulo",
  "position": null,
  "on_vacation": false,
  "birthday": null,
  "phone": null,
  "gender": null,
  "marital_status": null,
  "created_at": "2022-02-23T10:08:01-03:00",
  "in_company_since": null,
  "is_certified": false,
  "language": "pt-BR",
  "alt_id": "152f3edf59adbf8a45e4955ceca4d3e6",
  "oid": "92a6f5b72",
  "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",
      "work_time": 0
    },
    {
      "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",
      "work_time": 28800
    },
    {
      "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",
      "work_time": 28800
    },
    {
      "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",
      "work_time": 28800
    },
    {
      "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",
      "work_time": 28800
    },
    {
      "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",
      "work_time": 28800
    },
    {
      "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",
      "work_time": 0
    }
  ],
  "is_mensurable": true,
  "time_tracking_mode": "smart",
  "blocked_by_time_worked_at": null,
  "demanders_count": 0,
  "partners_count": 0,
  "has_all_users_as_partners": false,
  "has_all_users_as_demanders": false,
  "password_updated_at": null,
  "password_expired_at": null,
  "shift_work_time_per_week": 144000,
  "team_ids": [

  ],
  "led_team_ids": [

  ],
  "skip_time_adjust_on_task_assignment_deliver": false,
  "theme": "light",
  "task_list_background_image_url": null
}
DELETE

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

Remove a Task Follower

Request

Route

DELETE /api/v1.0/tasks/1/followers/coyote-420

Headers

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

cURL

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

Response

Simulated Response

Status

204

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=1

Headers

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

Query Parameters

task_id=1

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": 1,
  "workable_id": 1,
  "workable_type": "Task",
  "task_id": 1,
  "current_workflow_element_id": 1,
  "is_last_element": true,
  "is_first_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": 1
}

cURL

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

Response

Simulated Response

Status

201

Headers

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

Body

{
  "id": 1,
  "workable_id": 1,
  "workable_type": "Task",
  "task_id": 1,
  "current_workflow_element_id": 1,
  "is_last_element": true,
  "is_first_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": 1
}

cURL

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

Response

Simulated Response

Status

204

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 the task

string

follower_id

ID of user following the task

string

project_id

ID of the project the task belongs to

integer

is_closed

True if the task is delivered

boolean

false

is_working_on

True if any assignee is working on task

boolean

sort

Sort strategy.

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

1000

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-719&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-719
sort=close_date
sort_dir=desc
is_closed=true
project_id=1

cURL

curl "https://runrun.it/api/v1.0/tasks?responsible_id=coyote-719&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

200

Headers

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

Body

[
  {
    "id": 2,
    "title": "Improve Task API",
    "is_working_on": false,
    "user_id": "coyote-721",
    "type_id": 2,
    "project_id": 1,
    "team_id": null,
    "board_id": 2,
    "board_stage_id": 4,
    "board_stage_position": 70368744177664,
    "subtask_parent_position": null,
    "desired_date": null,
    "desired_date_with_time": null,
    "estimated_start_date": null,
    "estimated_delivery_date": null,
    "gantt_bar_start_date": null,
    "gantt_bar_end_date": null,
    "close_date": "2022-02-22T10:08:19-03:00",
    "was_reopened": false,
    "is_closed": true,
    "is_assigned": true,
    "on_going": false,
    "estimate_updated": true,
    "estimated_at": null,
    "queue_position": null,
    "created_at": "2022-02-23T10:08:19-03:00",
    "start_date": null,
    "desired_start_date": null,
    "current_estimate_seconds": 3600,
    "current_evaluator_id": null,
    "evaluation_status": null,
    "attachments_count": 0,
    "tags_data": [

    ],
    "client_name": "Test client 231",
    "client_id": 1,
    "project_name": "Test project 200",
    "project_group_name": "Sem grupo",
    "project_group_id": 1,
    "project_group_is_default": true,
    "project_sub_group_name": "Sem subgrupo",
    "project_sub_group_id": 1,
    "project_sub_group_is_default": true,
    "type_name": "TaskType 240",
    "user_name": "Coyote 721",
    "board_name": "Board 182",
    "board_stage_name": "Board Stage 549",
    "team_name": null,
    "type_color": "FFFFFF",
    "state": "closed",
    "overdue": "on_schedule",
    "time_worked": 0,
    "time_pending": 0,
    "time_total": 0,
    "time_progress": 0.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_days_ago": 0,
    "activities": 0,
    "repetition_rule": null,
    "board_remaining_time": null,
    "stage_depart_estimated_at": null,
    "is_urgent": false,
    "points": null,
    "reestimate_count": 0,
    "opened_parent_ids": [

    ],
    "parents_max_desired_date": null,
    "workflow_id": null,
    "checklist_id": null,
    "is_shared": false,
    "sharing_details": [

    ],
    "subtask_ids": [

    ],
    "subtasks_count": 0,
    "subtasks_closed_count": 0,
    "subtasks_count_progress": null,
    "is_subtask": false,
    "parent_task_id": null,
    "parent_task_title": null,
    "priority": null,
    "tag_list": "",
    "tags": [

    ],
    "scheduled_start_time": null,
    "is_scheduled": false,
    "uid": 2,
    "responsible_id": "coyote-719",
    "task_state_id": 4,
    "responsible_name": "Coyote 719",
    "task_state_name": "Board Stage 549",
    "activities_7_days_ago": 0,
    "repetition_rule_id": null,
    "current_worked_time": 0,
    "estimated_delivery_date_updated": true,
    "last_estimated_at": null,
    "task_tags": [

    ],
    "approved": null,
    "task_status_id": 4,
    "task_status_name": "Board Stage 549",
    "assignments": [
      {
        "id": "92a6f5b72",
        "task_id": 2,
        "assignee_id": "coyote-719",
        "team_id": null,
        "assignee_name": "Coyote 719",
        "team_name": null,
        "queue_position": 2,
        "priority": 2,
        "current_estimate_seconds": 3600,
        "time_worked": 0,
        "estimated_start_date": null,
        "estimate_updated": false,
        "start_date": null,
        "close_date": null,
        "is_closed": false,
        "reestimate_count": 0,
        "is_working_on": false,
        "automatic_time_worked_updated_at": "2022-02-23T10:08:19-03:00",
        "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-679/coyote-719/mini.png",
        "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-679/coyote-719/regular.png",
        "time_worked_not_persisted": 0
      }
    ],
    "follower_ids": [

    ]
  },
  {
    "id": 1,
    "title": "Create Task API",
    "is_working_on": false,
    "user_id": "coyote-720",
    "type_id": 1,
    "project_id": 1,
    "team_id": null,
    "board_id": 1,
    "board_stage_id": 1,
    "board_stage_position": 70368744177664,
    "subtask_parent_position": null,
    "desired_date": null,
    "desired_date_with_time": null,
    "estimated_start_date": null,
    "estimated_delivery_date": null,
    "gantt_bar_start_date": null,
    "gantt_bar_end_date": null,
    "close_date": "2022-02-21T10:08:18-03:00",
    "was_reopened": false,
    "is_closed": true,
    "is_assigned": true,
    "on_going": false,
    "estimate_updated": true,
    "estimated_at": null,
    "queue_position": null,
    "created_at": "2022-02-23T10:08:18-03:00",
    "start_date": null,
    "desired_start_date": null,
    "current_estimate_seconds": 3600,
    "current_evaluator_id": null,
    "evaluation_status": null,
    "attachments_count": 0,
    "tags_data": [

    ],
    "client_name": "Test client 231",
    "client_id": 1,
    "project_name": "Test project 200",
    "project_group_name": "Sem grupo",
    "project_group_id": 1,
    "project_group_is_default": true,
    "project_sub_group_name": "Sem subgrupo",
    "project_sub_group_id": 1,
    "project_sub_group_is_default": true,
    "type_name": "TaskType 239",
    "user_name": "Coyote 720",
    "board_name": "Board 181",
    "board_stage_name": "Board Stage 546",
    "team_name": null,
    "type_color": "FFFFFF",
    "state": "closed",
    "overdue": "on_schedule",
    "time_worked": 0,
    "time_pending": 0,
    "time_total": 0,
    "time_progress": 0.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_days_ago": 0,
    "activities": 0,
    "repetition_rule": null,
    "board_remaining_time": null,
    "stage_depart_estimated_at": null,
    "is_urgent": false,
    "points": null,
    "reestimate_count": 0,
    "opened_parent_ids": [

    ],
    "parents_max_desired_date": null,
    "workflow_id": null,
    "checklist_id": null,
    "is_shared": false,
    "sharing_details": [

    ],
    "subtask_ids": [

    ],
    "subtasks_count": 0,
    "subtasks_closed_count": 0,
    "subtasks_count_progress": null,
    "is_subtask": false,
    "parent_task_id": null,
    "parent_task_title": null,
    "priority": null,
    "tag_list": "",
    "tags": [

    ],
    "scheduled_start_time": null,
    "is_scheduled": false,
    "uid": 1,
    "responsible_id": "coyote-719",
    "task_state_id": 1,
    "responsible_name": "Coyote 719",
    "task_state_name": "Board Stage 546",
    "activities_7_days_ago": 0,
    "repetition_rule_id": null,
    "current_worked_time": 0,
    "estimated_delivery_date_updated": true,
    "last_estimated_at": null,
    "task_tags": [

    ],
    "approved": null,
    "task_status_id": 1,
    "task_status_name": "Board Stage 546",
    "assignments": [
      {
        "id": "49537adb9",
        "task_id": 1,
        "assignee_id": "coyote-719",
        "team_id": null,
        "assignee_name": "Coyote 719",
        "team_name": null,
        "queue_position": 1,
        "priority": 1,
        "current_estimate_seconds": 3600,
        "time_worked": 0,
        "estimated_start_date": null,
        "estimate_updated": false,
        "start_date": null,
        "close_date": null,
        "is_closed": false,
        "reestimate_count": 0,
        "is_working_on": false,
        "automatic_time_worked_updated_at": "2022-02-23T10:08:18-03:00",
        "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-679/coyote-719/mini.png",
        "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-679/coyote-719/regular.png",
        "time_worked_not_persisted": 0
      }
    ],
    "follower_ids": [

    ]
  }
]
POST

/api/v1.0/tasks/export

Export

Request

Route

POST /api/v1.0/tasks/export

Headers

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

Body

{
  "format_type": "xlsx"
}

cURL

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

Response

Simulated Response

Status

200

Headers

Content-Type: application/json
Content-Length: 0

Request

Route

POST /api/v1.0/tasks/export

Headers

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

Body

{
  "format_type": "csv"
}

cURL

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

Response

Simulated Response

Status

200

Headers

Content-Type: application/json
Content-Length: 0

Request

Route

POST /api/v1.0/tasks/export

Headers

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

Body

{
  "format_type": "bad_format"
}

cURL

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

Response

Simulated Response

Status

400

Headers

Content-Type: application/json
Content-Length: 0
GET

/api/v1.0/tasks/:id

Show a Task

Request

Route

GET /api/v1.0/tasks/1

Headers

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

cURL

curl "https://runrun.it/api/v1.0/tasks/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 Task ID integer
title Task title string
is_working_on True if any assignee is working on task boolean
user_id ID of user who created the task string
type_id ID of the task type integer
project_id ID of the project the task belongs to integer
team_id ID of the team the task belongs to (if not assigned) integer
board_id ID of the board the task belongs to integer
board_stage_id ID of the board stage the task belongs to integer
board_stage_position Position of the task on stage integer
subtask_parent_position Position of the task on parent task integer
desired_date Desired delivery date date
desired_date_with_time Desired delivery date and time date_time
estimated_start_date Date when the system estimates the task will be started date_time
estimated_delivery_date Date when the system estimates the task will be delivered date_time
gantt_bar_start_date Start date for Gantt chart date_time
gantt_bar_end_date End date for Gantt chart date_time
close_date Date when the task was delivered datetime
was_reopened True if the task has been reopened after being delivered boolean
is_closed True if the task is delivered boolean
is_assigned True if the task has anyone assigned boolean
on_going True if the task is an ongoing task boolean
estimate_updated True if estimate dates have been updated after potential change boolean
estimated_at Last time when task was estimated boolean
queue_position 1-based index of position on assignee user's task list integer
created_at Date when task was created datetime
start_date First time when task was worked on datetime
desired_start_date Desired start date date_time
current_estimate_seconds Current estimated effort (in seconds) integer
current_evaluator_id ID of current evaluator for this task string
evaluation_status Evaluation status ('approved' / 'rejected' / 'pending' / null) string
attachments_count Number of attachment that belongs to task integer
tags_data Tags for task array
client_name Name of client string
client_id ID of the client the task belongs to integer
project_name Name of project string
project_group_name Name of project group string
project_group_id ID of the group the task belongs to integer
project_group_is_default True if the project group is default boolean
project_sub_group_name Name of project subgroup string
project_sub_group_id ID of the sub group the task belongs to integer
project_sub_group_is_default True if the project subgroup is default boolean
type_name Name of task type string
user_name Name of user who created the task string
board_name Name of board string
board_stage_name Name of board stage string
team_name Name of team (if not assigned) string
type_color Task type color in hexadecimal format string
state Task state ('not_assigned', 'working_on', 'queued', 'closed') string
overdue Overdue status of the task ('on_schedule', 'soft_overdue', 'hard_overdue') string
time_worked Time (in seconds) worked in the task integer
time_pending Time (in seconds) pending in the task integer
time_total Total time (in seconds) spent in the task integer
time_progress Progress of time worked on the task float
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_0_days_ago Time (in seconds) worked in the task today integer
activities Total time (in seconds) worked today and in the last 6 days integer
repetition_rule Repetition rule integer
board_remaining_time Time (in seconds) remaining estimated to deliver the task on board integer
stage_depart_estimated_at Estimated date of departure from stage on board date_time
search_row_rank Search relevance integer
is_urgent True if the task is urgent boolean
points integer
reestimate_count Reestimate counter integer
parent_ids IDs from direct prerequisite tasks array
opened_parent_ids IDs from direct open prerequisite tasks array
parents_max_desired_date Maximum desired date of direct prerequisites. date_time
child_ids IDs from direct descendant tasks array
workflow_id Workflow id integer
checklist_id Checklist id integer
is_shared True if the task is shared boolean
sharing_details Sharing details array
subtask_ids Subtasks ids array
subtasks_count Subtasks count integer
subtasks_closed_count Subtasks closed count integer
subtasks_count_progress Subtasks count progress float
is_subtask True if the task is a subtask boolean
parent_task_id Parent task id integer
parent_task_title Parent task title string
priority [Deprecated] Use queue_position integer
tag_list [Deprecated] Use tags_data string
tags [Deprecated] Use tags_data array
scheduled_start_time [Deprecated] Use desired_start_date datetime
is_scheduled [Deprecated] Not used anymore boolean
follower_ids IDs of users following this task array
workflow_id ID of associated workflow (if any) integer

Status

200

Headers

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

Body

{
  "id": 1,
  "title": "Bla",
  "is_working_on": false,
  "user_id": "coyote-760",
  "type_id": 1,
  "project_id": 1,
  "team_id": null,
  "board_id": 1,
  "board_stage_id": 1,
  "board_stage_position": 70368744177664,
  "subtask_parent_position": null,
  "desired_date": null,
  "desired_date_with_time": null,
  "estimated_start_date": null,
  "estimated_delivery_date": null,
  "gantt_bar_start_date": null,
  "gantt_bar_end_date": null,
  "close_date": null,
  "was_reopened": false,
  "is_closed": false,
  "is_assigned": true,
  "on_going": false,
  "estimate_updated": false,
  "estimated_at": null,
  "queue_position": 1,
  "created_at": "2022-02-23T10:08:48-03:00",
  "start_date": null,
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "current_evaluator_id": null,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 244",
  "client_id": 1,
  "project_name": "Test project 213",
  "project_group_name": "Sem grupo",
  "project_group_id": 1,
  "project_group_is_default": true,
  "project_sub_group_name": "Sem subgrupo",
  "project_sub_group_id": 1,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 258",
  "user_name": "Coyote 760",
  "board_name": "Board 200",
  "board_stage_name": "Board Stage 603",
  "team_name": null,
  "type_color": "FFFFFF",
  "state": "queued",
  "overdue": "on_schedule",
  "time_worked": 0,
  "time_pending": 3600,
  "time_total": 3600,
  "time_progress": 0.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_days_ago": 0,
  "activities": 0,
  "repetition_rule": null,
  "board_remaining_time": null,
  "stage_depart_estimated_at": null,
  "is_urgent": false,
  "points": null,
  "reestimate_count": 0,
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "workflow_id": null,
  "checklist_id": null,
  "is_shared": false,
  "sharing_details": [

  ],
  "subtask_ids": [

  ],
  "subtasks_count": 0,
  "subtasks_closed_count": 0,
  "subtasks_count_progress": null,
  "is_subtask": false,
  "parent_task_id": null,
  "parent_task_title": null,
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "uid": 1,
  "responsible_id": "coyote-759",
  "task_state_id": 1,
  "responsible_name": "Coyote 759",
  "task_state_name": "Board Stage 603",
  "activities_7_days_ago": 0,
  "repetition_rule_id": null,
  "current_worked_time": 0,
  "estimated_delivery_date_updated": false,
  "last_estimated_at": null,
  "task_tags": [

  ],
  "approved": null,
  "task_status_id": 1,
  "task_status_name": "Board Stage 603",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-759",
      "team_id": null,
      "assignee_name": "Coyote 759",
      "team_name": null,
      "queue_position": 1,
      "priority": 1,
      "current_estimate_seconds": 3600,
      "time_worked": 0,
      "estimated_start_date": null,
      "estimate_updated": false,
      "start_date": null,
      "close_date": null,
      "is_closed": false,
      "reestimate_count": 0,
      "is_working_on": false,
      "automatic_time_worked_updated_at": "2022-02-23T10:08:48-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-690/coyote-759/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-690/coyote-759/regular.png",
      "time_worked_not_persisted": 0
    }
  ],
  "follower_ids": [

  ],
  "unseen_since": "2022-02-23T10:08:48-03:00"
}
GET

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

Show task subtasks

Request

Route

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

Headers

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

cURL

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

Response

Simulated Response

Response Fields

Name Description type
id Task ID integer
title Task title string
is_working_on True if any assignee is working on task boolean
user_id ID of user who created the task string
type_id ID of the task type integer
project_id ID of the project the task belongs to integer
team_id ID of the team the task belongs to (if not assigned) integer
board_id ID of the board the task belongs to integer
board_stage_id ID of the board stage the task belongs to integer
board_stage_position Position of the task on stage integer
subtask_parent_position Position of the task on parent task integer
desired_date Desired delivery date date
desired_date_with_time Desired delivery date and time date_time
estimated_start_date Date when the system estimates the task will be started date_time
estimated_delivery_date Date when the system estimates the task will be delivered date_time
gantt_bar_start_date Start date for Gantt chart date_time
gantt_bar_end_date End date for Gantt chart date_time
close_date Date when the task was delivered datetime
was_reopened True if the task has been reopened after being delivered boolean
is_closed True if the task is delivered boolean
is_assigned True if the task has anyone assigned boolean
on_going True if the task is an ongoing task boolean
estimate_updated True if estimate dates have been updated after potential change boolean
estimated_at Last time when task was estimated boolean
queue_position 1-based index of position on assignee user's task list integer
created_at Date when task was created datetime
start_date First time when task was worked on datetime
desired_start_date Desired start date date_time
current_estimate_seconds Current estimated effort (in seconds) integer
current_evaluator_id ID of current evaluator for this task string
evaluation_status Evaluation status ('approved' / 'rejected' / 'pending' / null) string
attachments_count Number of attachment that belongs to task integer
tags_data Tags for task array
client_name Name of client string
client_id ID of the client the task belongs to integer
project_name Name of project string
project_group_name Name of project group string
project_group_id ID of the group the task belongs to integer
project_group_is_default True if the project group is default boolean
project_sub_group_name Name of project subgroup string
project_sub_group_id ID of the sub group the task belongs to integer
project_sub_group_is_default True if the project subgroup is default boolean
type_name Name of task type string
user_name Name of user who created the task string
board_name Name of board string
board_stage_name Name of board stage string
team_name Name of team (if not assigned) string
type_color Task type color in hexadecimal format string
state Task state ('not_assigned', 'working_on', 'queued', 'closed') string
overdue Overdue status of the task ('on_schedule', 'soft_overdue', 'hard_overdue') string
time_worked Time (in seconds) worked in the task integer
time_pending Time (in seconds) pending in the task integer
time_total Total time (in seconds) spent in the task integer
time_progress Progress of time worked on the task float
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_0_days_ago Time (in seconds) worked in the task today integer
activities Total time (in seconds) worked today and in the last 6 days integer
repetition_rule Repetition rule integer
board_remaining_time Time (in seconds) remaining estimated to deliver the task on board integer
stage_depart_estimated_at Estimated date of departure from stage on board date_time
search_row_rank Search relevance integer
is_urgent True if the task is urgent boolean
points integer
reestimate_count Reestimate counter integer
parent_ids IDs from direct prerequisite tasks array
opened_parent_ids IDs from direct open prerequisite tasks array
parents_max_desired_date Maximum desired date of direct prerequisites. date_time
child_ids IDs from direct descendant tasks array
workflow_id Workflow id integer
checklist_id Checklist id integer
is_shared True if the task is shared boolean
sharing_details Sharing details array
subtask_ids Subtasks ids array
subtasks_count Subtasks count integer
subtasks_closed_count Subtasks closed count integer
subtasks_count_progress Subtasks count progress float
is_subtask True if the task is a subtask boolean
parent_task_id Parent task id integer
parent_task_title Parent task title string
priority [Deprecated] Use queue_position integer
tag_list [Deprecated] Use tags_data string
tags [Deprecated] Use tags_data array
scheduled_start_time [Deprecated] Use desired_start_date datetime
is_scheduled [Deprecated] Not used anymore boolean
follower_ids IDs of users following this task array
workflow_id ID of associated workflow (if any) integer

Status

200

Headers

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

Body

[
  {
    "id": 2,
    "title": "Subtask",
    "is_working_on": false,
    "user_id": "coyote-763",
    "type_id": 2,
    "project_id": 2,
    "team_id": null,
    "board_id": 2,
    "board_stage_id": 4,
    "board_stage_position": 70368744177664,
    "subtask_parent_position": null,
    "desired_date": null,
    "desired_date_with_time": null,
    "estimated_start_date": null,
    "estimated_delivery_date": null,
    "gantt_bar_start_date": null,
    "gantt_bar_end_date": null,
    "close_date": null,
    "was_reopened": false,
    "is_closed": false,
    "is_assigned": true,
    "on_going": false,
    "estimate_updated": false,
    "estimated_at": null,
    "queue_position": 2,
    "created_at": "2022-02-23T10:08:50-03:00",
    "start_date": null,
    "desired_start_date": null,
    "current_estimate_seconds": 3600,
    "current_evaluator_id": null,
    "evaluation_status": null,
    "attachments_count": 0,
    "tags_data": [

    ],
    "client_name": "Test client 246",
    "client_id": 2,
    "project_name": "Test project 215",
    "project_group_name": "Sem grupo",
    "project_group_id": 2,
    "project_group_is_default": true,
    "project_sub_group_name": "Sem subgrupo",
    "project_sub_group_id": 2,
    "project_sub_group_is_default": true,
    "type_name": "TaskType 260",
    "user_name": "Coyote 763",
    "board_name": "Board 202",
    "board_stage_name": "Board Stage 609",
    "team_name": null,
    "type_color": "FFFFFF",
    "state": "queued",
    "overdue": "on_schedule",
    "time_worked": 0,
    "time_pending": 3600,
    "time_total": 3600,
    "time_progress": 0.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_days_ago": 0,
    "activities": 0,
    "repetition_rule": null,
    "board_remaining_time": null,
    "stage_depart_estimated_at": null,
    "is_urgent": false,
    "points": null,
    "reestimate_count": 0,
    "opened_parent_ids": [

    ],
    "parents_max_desired_date": null,
    "workflow_id": null,
    "checklist_id": null,
    "is_shared": false,
    "sharing_details": [

    ],
    "subtask_ids": [

    ],
    "subtasks_count": 0,
    "subtasks_closed_count": 0,
    "subtasks_count_progress": null,
    "is_subtask": true,
    "parent_task_id": null,
    "parent_task_title": null,
    "priority": 2,
    "tag_list": "",
    "tags": [

    ],
    "scheduled_start_time": null,
    "is_scheduled": false,
    "uid": 2,
    "responsible_id": "coyote-761",
    "task_state_id": 4,
    "responsible_name": "Coyote 761",
    "task_state_name": "Board Stage 609",
    "activities_7_days_ago": 0,
    "repetition_rule_id": null,
    "current_worked_time": 0,
    "estimated_delivery_date_updated": false,
    "last_estimated_at": null,
    "task_tags": [

    ],
    "approved": null,
    "task_status_id": 4,
    "task_status_name": "Board Stage 609",
    "assignments": [
      {
        "id": "92a6f5b72",
        "task_id": 2,
        "assignee_id": "coyote-761",
        "team_id": null,
        "assignee_name": "Coyote 761",
        "team_name": null,
        "queue_position": 2,
        "priority": 2,
        "current_estimate_seconds": 3600,
        "time_worked": 0,
        "estimated_start_date": null,
        "estimate_updated": false,
        "start_date": null,
        "close_date": null,
        "is_closed": false,
        "reestimate_count": 0,
        "is_working_on": false,
        "automatic_time_worked_updated_at": "2022-02-23T10:08:50-03:00",
        "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-691/coyote-761/mini.png",
        "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-691/coyote-761/regular.png",
        "time_worked_not_persisted": 0
      }
    ],
    "follower_ids": [

    ]
  }
]
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

Task title

string

task[on_going] required

True if the task is an ongoing task

boolean

task[type_id] required

ID of the task type

integer

task[project_id] required

ID of the project the task belongs to

integer

task[desired_start_date]

Desired start date

date_time

task[desired_date] required

Desired delivery date

date_time

task[tag_list]

[Deprecated] Use tags_data

string

task[assignments]

Objects of task assignments

array

task[task_prerequisite_ids]

IDs of pre-requisite tasks

array

task[task_descendant_ids]

IDs of descendant 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": {
    "type_id": 1,
    "project_id": 1,
    "title": "Bla",
    "desired_date": null,
    "on_going": false,
    "tag_list": null,
    "assignments": [
      {
        "assignee_id": "coyote-764",
        "team_id": 1
      }
    ],
    "source": "my_source_value"
  }
}

cURL

curl "https://runrun.it/api/v1.0/tasks" -d '{"task":{"type_id":1,"project_id":1,"title":"Bla","desired_date":null,"on_going":false,"tag_list":null,"assignments":[{"assignee_id":"coyote-764","team_id":1}],"source":"my_source_value"}}' -X POST \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

201

Headers

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

Body

{
  "id": 1,
  "title": "Bla",
  "is_working_on": false,
  "user_id": "coyote-764",
  "type_id": 1,
  "project_id": 1,
  "team_id": 1,
  "board_id": 1,
  "board_stage_id": 1,
  "board_stage_position": 70368744177664,
  "subtask_parent_position": null,
  "desired_date": null,
  "desired_date_with_time": null,
  "estimated_start_date": null,
  "estimated_delivery_date": null,
  "gantt_bar_start_date": null,
  "gantt_bar_end_date": null,
  "close_date": null,
  "was_reopened": false,
  "is_closed": false,
  "is_assigned": true,
  "on_going": false,
  "estimate_updated": true,
  "estimated_at": "2022-02-23T10:08:53-03:00",
  "queue_position": 1,
  "created_at": "2022-02-23T10:08:53-03:00",
  "start_date": null,
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "current_evaluator_id": null,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 247",
  "client_id": 1,
  "project_name": "Test project 216",
  "project_group_name": "Sem grupo",
  "project_group_id": 1,
  "project_group_is_default": true,
  "project_sub_group_name": "Sem subgrupo",
  "project_sub_group_id": 1,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 261",
  "user_name": "Coyote 764",
  "board_name": "Board 203",
  "board_stage_name": "Board Stage 612",
  "team_name": "Test team 51",
  "type_color": "FFFFFF",
  "state": "queued",
  "overdue": "on_schedule",
  "time_worked": 0,
  "time_pending": 3600,
  "time_total": 3600,
  "time_progress": 0.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_days_ago": 0,
  "activities": 0,
  "repetition_rule": null,
  "board_remaining_time": null,
  "stage_depart_estimated_at": null,
  "is_urgent": false,
  "points": null,
  "reestimate_count": 0,
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "workflow_id": null,
  "checklist_id": null,
  "is_shared": false,
  "sharing_details": [

  ],
  "subtask_ids": [

  ],
  "subtasks_count": 0,
  "subtasks_closed_count": 0,
  "subtasks_count_progress": null,
  "is_subtask": false,
  "parent_task_id": null,
  "parent_task_title": null,
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "uid": 1,
  "responsible_id": "coyote-764",
  "task_state_id": 1,
  "responsible_name": "Coyote 764",
  "task_state_name": "Board Stage 612",
  "activities_7_days_ago": 0,
  "repetition_rule_id": null,
  "current_worked_time": 0,
  "estimated_delivery_date_updated": true,
  "last_estimated_at": "2022-02-23T10:08:53-03:00",
  "task_tags": [

  ],
  "approved": null,
  "task_status_id": 1,
  "task_status_name": "Board Stage 612",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-764",
      "team_id": 1,
      "assignee_name": "Coyote 764",
      "team_name": "Test team 51",
      "queue_position": 1,
      "priority": 1,
      "current_estimate_seconds": 3600,
      "time_worked": 0,
      "estimated_start_date": null,
      "estimate_updated": false,
      "start_date": null,
      "close_date": null,
      "is_closed": false,
      "reestimate_count": 0,
      "is_working_on": false,
      "automatic_time_worked_updated_at": "2022-02-23T10:08:53-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-692/coyote-764/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-692/coyote-764/regular.png",
      "time_worked_not_persisted": 0
    }
  ],
  "follower_ids": [

  ]
}
POST

/api/v1.0/tasks

Create a task with subtasks_data

Parameters

Name Description type
task[title] required

Task title

string

task[on_going] required

True if the task is an ongoing task

boolean

task[type_id] required

ID of the task type

integer

task[project_id] required

ID of the project the task belongs to

integer

task[desired_start_date]

Desired start date

date_time

task[desired_date] required

Desired delivery date

date_time

task[tag_list]

[Deprecated] Use tags_data

string

task[assignments]

Objects of task assignments

array

task[task_prerequisite_ids]

IDs of pre-requisite tasks

array

task[task_descendant_ids]

IDs of descendant 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": {
    "type_id": 1,
    "project_id": 1,
    "title": "Bla",
    "desired_date": null,
    "on_going": false,
    "tag_list": null,
    "assignments": [
      {
        "assignee_id": "coyote-767",
        "team_id": 1
      }
    ],
    "subtasks_data": [
      {
        "title": "Subtarefa 1"
      },
      {
        "title": "Subtarefa 2",
        "desired_date": "2021-02-21 10:30 0300",
        "assignments_data": [
          {
            "assignee_id": "coyote-767",
            "team_id": 1
          }
        ]
      },
      {
        "title": "Subtarefa 3",
        "desired_date": "2021-02-21 10:30 0300",
        "assignments_data": [
          {
            "assignee_id": "coyote-770",
            "team_id": 1
          }
        ]
      }
    ]
  },
  "authorize_and_assign": true
}

cURL

curl "https://runrun.it/api/v1.0/tasks" -d '{"task":{"type_id":1,"project_id":1,"title":"Bla","desired_date":null,"on_going":false,"tag_list":null,"assignments":[{"assignee_id":"coyote-767","team_id":1}],"subtasks_data":[{"title":"Subtarefa 1"},{"title":"Subtarefa 2","desired_date":"2021-02-21 10:30 0300","assignments_data":[{"assignee_id":"coyote-767","team_id":1}]},{"title":"Subtarefa 3","desired_date":"2021-02-21 10:30 0300","assignments_data":[{"assignee_id":"coyote-770","team_id":1}]}]},"authorize_and_assign":true}' -X POST \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

201

Headers

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

Body

{
  "id": 1,
  "title": "Bla",
  "is_working_on": false,
  "user_id": "coyote-767",
  "type_id": 1,
  "project_id": 1,
  "team_id": 1,
  "board_id": 1,
  "board_stage_id": 1,
  "board_stage_position": 281474976710656,
  "subtask_parent_position": null,
  "desired_date": null,
  "desired_date_with_time": null,
  "estimated_start_date": null,
  "estimated_delivery_date": null,
  "gantt_bar_start_date": null,
  "gantt_bar_end_date": null,
  "close_date": null,
  "was_reopened": false,
  "is_closed": false,
  "is_assigned": true,
  "on_going": false,
  "estimate_updated": true,
  "estimated_at": "2022-02-23T10:08:57-03:00",
  "queue_position": 1,
  "created_at": "2022-02-23T10:08:55-03:00",
  "start_date": null,
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "current_evaluator_id": null,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 248",
  "client_id": 1,
  "project_name": "Test project 217",
  "project_group_name": "Sem grupo",
  "project_group_id": 1,
  "project_group_is_default": true,
  "project_sub_group_name": "Sem subgrupo",
  "project_sub_group_id": 1,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 262",
  "user_name": "Coyote 767",
  "board_name": "Board 205",
  "board_stage_name": "Board Stage 618",
  "team_name": "Test team 52",
  "type_color": "FFFFFF",
  "state": "queued",
  "overdue": "on_schedule",
  "time_worked": 0,
  "time_pending": 3600,
  "time_total": 3600,
  "time_progress": 0.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_days_ago": 0,
  "activities": 0,
  "repetition_rule": null,
  "board_remaining_time": null,
  "stage_depart_estimated_at": null,
  "is_urgent": false,
  "points": null,
  "reestimate_count": 0,
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "workflow_id": null,
  "checklist_id": null,
  "is_shared": false,
  "sharing_details": [

  ],
  "subtask_ids": [
    4,
    3,
    2
  ],
  "subtasks_count": 3,
  "subtasks_closed_count": 0,
  "subtasks_count_progress": "0.0",
  "is_subtask": false,
  "parent_task_id": null,
  "parent_task_title": null,
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "uid": 1,
  "responsible_id": "coyote-767",
  "task_state_id": 1,
  "responsible_name": "Coyote 767",
  "task_state_name": "Board Stage 618",
  "activities_7_days_ago": 0,
  "repetition_rule_id": null,
  "current_worked_time": 0,
  "estimated_delivery_date_updated": true,
  "last_estimated_at": "2022-02-23T10:08:57-03:00",
  "task_tags": [

  ],
  "approved": null,
  "task_status_id": 1,
  "task_status_name": "Board Stage 618",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-767",
      "team_id": 1,
      "assignee_name": "Coyote 767",
      "team_name": "Test team 52",
      "queue_position": 1,
      "priority": 1,
      "current_estimate_seconds": 3600,
      "time_worked": 0,
      "estimated_start_date": null,
      "estimate_updated": false,
      "start_date": null,
      "close_date": null,
      "is_closed": false,
      "reestimate_count": 0,
      "is_working_on": false,
      "automatic_time_worked_updated_at": "2022-02-23T10:08:55-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-694/coyote-767/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-694/coyote-767/regular.png",
      "time_worked_not_persisted": 0
    }
  ],
  "follower_ids": [

  ]
}
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

Task ID

integer

Request

Route

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

Headers

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

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": 1,
  "title": "Bla",
  "is_working_on": true,
  "user_id": "coyote-833",
  "type_id": 1,
  "project_id": 1,
  "team_id": null,
  "board_id": 1,
  "board_stage_id": 1,
  "board_stage_position": 70368744177664,
  "subtask_parent_position": null,
  "desired_date": null,
  "desired_date_with_time": null,
  "estimated_start_date": null,
  "estimated_delivery_date": null,
  "gantt_bar_start_date": null,
  "gantt_bar_end_date": null,
  "close_date": null,
  "was_reopened": false,
  "is_closed": false,
  "is_assigned": true,
  "on_going": false,
  "estimate_updated": false,
  "estimated_at": null,
  "queue_position": 1,
  "created_at": "2022-02-23T10:10:01-03:00",
  "start_date": null,
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "current_evaluator_id": null,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 274",
  "client_id": 1,
  "project_name": "Test project 243",
  "project_group_name": "Sem grupo",
  "project_group_id": 1,
  "project_group_is_default": true,
  "project_sub_group_name": "Sem subgrupo",
  "project_sub_group_id": 1,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 292",
  "user_name": "Coyote 833",
  "board_name": "Board 244",
  "board_stage_name": "Board Stage 735",
  "team_name": null,
  "type_color": "FFFFFF",
  "state": "working_on",
  "overdue": "on_schedule",
  "time_worked": 0,
  "time_pending": 3600,
  "time_total": 3600,
  "time_progress": 0.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_days_ago": 0,
  "activities": 0,
  "repetition_rule": null,
  "board_remaining_time": null,
  "stage_depart_estimated_at": null,
  "is_urgent": false,
  "points": null,
  "reestimate_count": 0,
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "workflow_id": null,
  "checklist_id": null,
  "is_shared": false,
  "sharing_details": [

  ],
  "subtask_ids": [

  ],
  "subtasks_count": 0,
  "subtasks_closed_count": 0,
  "subtasks_count_progress": null,
  "is_subtask": false,
  "parent_task_id": null,
  "parent_task_title": null,
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "uid": 1,
  "responsible_id": "coyote-832",
  "task_state_id": 1,
  "responsible_name": "Coyote 832",
  "task_state_name": "Board Stage 735",
  "activities_7_days_ago": 0,
  "repetition_rule_id": null,
  "current_worked_time": 0,
  "estimated_delivery_date_updated": false,
  "last_estimated_at": null,
  "task_tags": [

  ],
  "approved": null,
  "task_status_id": 1,
  "task_status_name": "Board Stage 735",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-832",
      "team_id": null,
      "assignee_name": "Coyote 832",
      "team_name": null,
      "queue_position": 1,
      "priority": 1,
      "current_estimate_seconds": 3600,
      "time_worked": 0,
      "estimated_start_date": null,
      "estimate_updated": false,
      "start_date": "2022-02-23T10:10:02-03:00",
      "close_date": null,
      "is_closed": false,
      "reestimate_count": 0,
      "is_working_on": true,
      "automatic_time_worked_updated_at": "2022-02-23T10:10:02-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-729/coyote-832/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-729/coyote-832/regular.png",
      "time_worked_not_persisted": 0
    }
  ],
  "follower_ids": [

  ]
}
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

Task ID

integer

Request

Route

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

Headers

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

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": 1,
  "title": "Bla",
  "is_working_on": false,
  "user_id": "coyote-837",
  "type_id": 1,
  "project_id": 1,
  "team_id": null,
  "board_id": 1,
  "board_stage_id": 1,
  "board_stage_position": 70368744177664,
  "subtask_parent_position": null,
  "desired_date": null,
  "desired_date_with_time": null,
  "estimated_start_date": null,
  "estimated_delivery_date": null,
  "gantt_bar_start_date": null,
  "gantt_bar_end_date": null,
  "close_date": null,
  "was_reopened": false,
  "is_closed": false,
  "is_assigned": true,
  "on_going": false,
  "estimate_updated": false,
  "estimated_at": null,
  "queue_position": 1,
  "created_at": "2022-02-23T10:10:06-03:00",
  "start_date": "2022-02-23T10:10:06-03:00",
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "current_evaluator_id": null,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 276",
  "client_id": 1,
  "project_name": "Test project 245",
  "project_group_name": "Sem grupo",
  "project_group_id": 1,
  "project_group_is_default": true,
  "project_sub_group_name": "Sem subgrupo",
  "project_sub_group_id": 1,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 294",
  "user_name": "Coyote 837",
  "board_name": "Board 246",
  "board_stage_name": "Board Stage 741",
  "team_name": null,
  "type_color": "FFFFFF",
  "state": "queued",
  "overdue": "on_schedule",
  "time_worked": 0,
  "time_pending": 3600,
  "time_total": 3600,
  "time_progress": 0.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_days_ago": 0,
  "activities": 0,
  "repetition_rule": null,
  "board_remaining_time": null,
  "stage_depart_estimated_at": null,
  "is_urgent": false,
  "points": null,
  "reestimate_count": 0,
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "workflow_id": null,
  "checklist_id": null,
  "is_shared": false,
  "sharing_details": [

  ],
  "subtask_ids": [

  ],
  "subtasks_count": 0,
  "subtasks_closed_count": 0,
  "subtasks_count_progress": null,
  "is_subtask": false,
  "parent_task_id": null,
  "parent_task_title": null,
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "uid": 1,
  "responsible_id": "coyote-837",
  "task_state_id": 1,
  "responsible_name": "Coyote 837",
  "task_state_name": "Board Stage 741",
  "activities_7_days_ago": 0,
  "repetition_rule_id": null,
  "current_worked_time": 0,
  "estimated_delivery_date_updated": false,
  "last_estimated_at": null,
  "task_tags": [

  ],
  "approved": null,
  "task_status_id": 1,
  "task_status_name": "Board Stage 741",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-836",
      "team_id": null,
      "assignee_name": "Coyote 836",
      "team_name": null,
      "queue_position": 1,
      "priority": 1,
      "current_estimate_seconds": 3600,
      "time_worked": 0,
      "estimated_start_date": "2022-02-23T10:10:06-03:00",
      "estimate_updated": false,
      "start_date": "2022-02-23T10:10:06-03:00",
      "close_date": null,
      "is_closed": false,
      "reestimate_count": 0,
      "is_working_on": false,
      "automatic_time_worked_updated_at": "2022-02-23T10:10:06-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-731/coyote-836/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-731/coyote-836/regular.png",
      "time_worked_not_persisted": 0
    }
  ],
  "follower_ids": [

  ]
}
POST

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

Change a Task status to another

Parameters

Name Description type
id

Task ID

integer

task_status_id required

Request

Route

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

Headers

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

Body

{
  "task_status_id": 2
}

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": 1,
  "title": "Bla",
  "is_working_on": true,
  "user_id": "coyote-839",
  "type_id": 1,
  "project_id": 1,
  "team_id": null,
  "board_id": 1,
  "board_stage_id": 2,
  "board_stage_position": 70368744177664,
  "subtask_parent_position": null,
  "desired_date": null,
  "desired_date_with_time": null,
  "estimated_start_date": null,
  "estimated_delivery_date": null,
  "gantt_bar_start_date": null,
  "gantt_bar_end_date": null,
  "close_date": null,
  "was_reopened": false,
  "is_closed": false,
  "is_assigned": true,
  "on_going": false,
  "estimate_updated": true,
  "estimated_at": "2022-02-23T10:10:08-03:00",
  "queue_position": 1,
  "created_at": "2022-02-23T10:10:08-03:00",
  "start_date": null,
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "current_evaluator_id": null,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 277",
  "client_id": 1,
  "project_name": "Test project 246",
  "project_group_name": "Sem grupo",
  "project_group_id": 1,
  "project_group_is_default": true,
  "project_sub_group_name": "Sem subgrupo",
  "project_sub_group_id": 1,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 295",
  "user_name": "Coyote 839",
  "board_name": "Board 247",
  "board_stage_name": "Board Stage 745",
  "team_name": null,
  "type_color": "FFFFFF",
  "state": "queued",
  "overdue": "on_schedule",
  "time_worked": 0,
  "time_pending": 3600,
  "time_total": 3600,
  "time_progress": 0.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_days_ago": 0,
  "activities": 0,
  "repetition_rule": null,
  "board_remaining_time": null,
  "stage_depart_estimated_at": null,
  "is_urgent": false,
  "points": null,
  "reestimate_count": 0,
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "workflow_id": null,
  "checklist_id": null,
  "is_shared": false,
  "sharing_details": [

  ],
  "subtask_ids": [

  ],
  "subtasks_count": 0,
  "subtasks_closed_count": 0,
  "subtasks_count_progress": null,
  "is_subtask": false,
  "parent_task_id": null,
  "parent_task_title": null,
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "uid": 1,
  "responsible_id": "coyote-838",
  "task_state_id": 2,
  "responsible_name": "Coyote 838",
  "task_state_name": "Board Stage 745",
  "activities_7_days_ago": 0,
  "repetition_rule_id": null,
  "current_worked_time": 0,
  "estimated_delivery_date_updated": true,
  "last_estimated_at": "2022-02-23T10:10:08-03:00",
  "task_tags": [

  ],
  "approved": null,
  "task_status_id": 2,
  "task_status_name": "Board Stage 745",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-838",
      "team_id": null,
      "assignee_name": "Coyote 838",
      "team_name": null,
      "queue_position": 1,
      "priority": 1,
      "current_estimate_seconds": 3600,
      "time_worked": 0,
      "estimated_start_date": null,
      "estimate_updated": false,
      "start_date": null,
      "close_date": null,
      "is_closed": false,
      "reestimate_count": 0,
      "is_working_on": false,
      "automatic_time_worked_updated_at": "2022-02-23T10:10:08-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-732/coyote-838/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-732/coyote-838/regular.png",
      "time_worked_not_persisted": 0
    }
  ],
  "follower_ids": [

  ]
}
POST

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

Deliver a Task

Deliver a task.

The task is eligible to be delivered if:

  • it's not already delivered
  • it does not have any open prerequisite tasks

Parameters

Name Description type
id

Task ID

integer

Request

Route

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

Headers

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

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": 1,
  "title": "Bla",
  "is_working_on": false,
  "user_id": "coyote-857",
  "type_id": 1,
  "project_id": 1,
  "team_id": null,
  "board_id": 1,
  "board_stage_id": 3,
  "board_stage_position": null,
  "subtask_parent_position": null,
  "desired_date": null,
  "desired_date_with_time": null,
  "estimated_start_date": null,
  "estimated_delivery_date": null,
  "gantt_bar_start_date": null,
  "gantt_bar_end_date": null,
  "close_date": "2022-02-23T10:10:26-03:00",
  "was_reopened": false,
  "is_closed": true,
  "is_assigned": true,
  "on_going": false,
  "estimate_updated": true,
  "estimated_at": null,
  "queue_position": null,
  "created_at": "2022-02-23T10:10:26-03:00",
  "start_date": "2022-02-23T10:10:26-03:00",
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "current_evaluator_id": null,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 286",
  "client_id": 1,
  "project_name": "Test project 257",
  "project_group_name": "Sem grupo",
  "project_group_id": 1,
  "project_group_is_default": true,
  "project_sub_group_name": "Sem subgrupo",
  "project_sub_group_id": 1,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 306",
  "user_name": "Coyote 857",
  "board_name": "Board 257",
  "board_stage_name": "Board Stage 774",
  "team_name": null,
  "type_color": "FFFFFF",
  "state": "closed",
  "overdue": "on_schedule",
  "time_worked": 0,
  "time_pending": 0,
  "time_total": 0,
  "time_progress": 0.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_days_ago": 0,
  "activities": 0,
  "repetition_rule": null,
  "board_remaining_time": 0,
  "stage_depart_estimated_at": null,
  "is_urgent": false,
  "points": null,
  "reestimate_count": 0,
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "workflow_id": null,
  "checklist_id": null,
  "is_shared": false,
  "sharing_details": [

  ],
  "subtask_ids": [

  ],
  "subtasks_count": 0,
  "subtasks_closed_count": 0,
  "subtasks_count_progress": null,
  "is_subtask": false,
  "parent_task_id": null,
  "parent_task_title": null,
  "priority": null,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "uid": 1,
  "responsible_id": "coyote-856",
  "task_state_id": 3,
  "responsible_name": "Coyote 856",
  "task_state_name": "Board Stage 774",
  "activities_7_days_ago": 0,
  "repetition_rule_id": null,
  "current_worked_time": 0,
  "estimated_delivery_date_updated": true,
  "last_estimated_at": null,
  "task_tags": [

  ],
  "approved": null,
  "task_status_id": 3,
  "task_status_name": "Board Stage 774",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-856",
      "team_id": null,
      "assignee_name": "Coyote 856",
      "team_name": null,
      "queue_position": null,
      "priority": null,
      "current_estimate_seconds": 3600,
      "time_worked": 0,
      "estimated_start_date": null,
      "estimate_updated": true,
      "start_date": "2022-02-23T10:10:26-03:00",
      "close_date": "2022-02-23T10:10:26-03:00",
      "is_closed": true,
      "reestimate_count": 0,
      "is_working_on": false,
      "automatic_time_worked_updated_at": "2022-02-23T10:10:26-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-741/coyote-856/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-741/coyote-856/regular.png",
      "time_worked_not_persisted": 0
    }
  ],
  "follower_ids": [

  ]
}
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

Task ID

integer

reopen_or_pause_descendant_tasks

Force pause/reopen all descendant tasks

boolean

Request

Route

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

Headers

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

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": 1,
  "title": "Bla",
  "is_working_on": false,
  "user_id": "coyote-863",
  "type_id": 1,
  "project_id": 1,
  "team_id": null,
  "board_id": 1,
  "board_stage_id": 2,
  "board_stage_position": 70368744177664,
  "subtask_parent_position": null,
  "desired_date": null,
  "desired_date_with_time": null,
  "estimated_start_date": null,
  "estimated_delivery_date": null,
  "gantt_bar_start_date": null,
  "gantt_bar_end_date": null,
  "close_date": null,
  "was_reopened": true,
  "is_closed": false,
  "is_assigned": true,
  "on_going": false,
  "estimate_updated": true,
  "estimated_at": "2022-02-23T10:10:32-03:00",
  "queue_position": 1,
  "created_at": "2022-02-23T10:10:31-03:00",
  "start_date": "2022-02-23T10:10:32-03:00",
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "current_evaluator_id": null,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 288",
  "client_id": 1,
  "project_name": "Test project 259",
  "project_group_name": "Sem grupo",
  "project_group_id": 1,
  "project_group_is_default": true,
  "project_sub_group_name": "Sem subgrupo",
  "project_sub_group_id": 1,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 308",
  "user_name": "Coyote 863",
  "board_name": "Board 259",
  "board_stage_name": "Board Stage 779",
  "team_name": null,
  "type_color": "FFFFFF",
  "state": "queued",
  "overdue": "on_schedule",
  "time_worked": 0,
  "time_pending": 3600,
  "time_total": 3600,
  "time_progress": 0.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_days_ago": 0,
  "activities": 0,
  "repetition_rule": null,
  "board_remaining_time": null,
  "stage_depart_estimated_at": null,
  "is_urgent": false,
  "points": null,
  "reestimate_count": 0,
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "workflow_id": null,
  "checklist_id": null,
  "is_shared": false,
  "sharing_details": [

  ],
  "subtask_ids": [

  ],
  "subtasks_count": 0,
  "subtasks_closed_count": 0,
  "subtasks_count_progress": null,
  "is_subtask": false,
  "parent_task_id": null,
  "parent_task_title": null,
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "uid": 1,
  "responsible_id": "coyote-862",
  "task_state_id": 2,
  "responsible_name": "Coyote 862",
  "task_state_name": "Board Stage 779",
  "activities_7_days_ago": 0,
  "repetition_rule_id": null,
  "current_worked_time": 0,
  "estimated_delivery_date_updated": true,
  "last_estimated_at": "2022-02-23T10:10:32-03:00",
  "task_tags": [

  ],
  "approved": null,
  "task_status_id": 2,
  "task_status_name": "Board Stage 779",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-862",
      "team_id": null,
      "assignee_name": "Coyote 862",
      "team_name": null,
      "queue_position": 1,
      "priority": 1,
      "current_estimate_seconds": 3600,
      "time_worked": 0,
      "estimated_start_date": null,
      "estimate_updated": false,
      "start_date": "2022-02-23T10:10:32-03:00",
      "close_date": null,
      "is_closed": false,
      "reestimate_count": 0,
      "is_working_on": false,
      "automatic_time_worked_updated_at": "2022-02-23T10:10:31-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-744/coyote-862/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-744/coyote-862/regular.png",
      "time_worked_not_persisted": 0
    }
  ],
  "follower_ids": [

  ]
}
POST

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

Reposition a Task

Parameters

Name Description type
id required

Task ID

integer

queue_position required

The new queue position on responsible user's task list

integer

Request

Route

POST /api/v1.0/tasks/4/reposition

Headers

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

Body

{
  "queue_position": 2
}

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": 4,
  "title": "Bla",
  "is_working_on": false,
  "user_id": "coyote-865",
  "type_id": 4,
  "project_id": 4,
  "team_id": null,
  "board_id": 4,
  "board_stage_id": 10,
  "board_stage_position": 70368744177664,
  "subtask_parent_position": null,
  "desired_date": null,
  "desired_date_with_time": null,
  "estimated_start_date": null,
  "estimated_delivery_date": null,
  "gantt_bar_start_date": null,
  "gantt_bar_end_date": null,
  "close_date": null,
  "was_reopened": false,
  "is_closed": false,
  "is_assigned": true,
  "on_going": false,
  "estimate_updated": false,
  "estimated_at": null,
  "queue_position": 4,
  "created_at": "2022-02-23T10:10:38-03:00",
  "start_date": null,
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "current_evaluator_id": null,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 297",
  "client_id": 4,
  "project_name": "Test project 268",
  "project_group_name": "Sem grupo",
  "project_group_id": 4,
  "project_group_is_default": true,
  "project_sub_group_name": "Sem subgrupo",
  "project_sub_group_id": 4,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 317",
  "user_name": "Coyote 865",
  "board_name": "Board 268",
  "board_stage_name": "Board Stage 805",
  "team_name": null,
  "type_color": "FFFFFF",
  "state": "queued",
  "overdue": "on_schedule",
  "time_worked": 0,
  "time_pending": 3600,
  "time_total": 3600,
  "time_progress": 0.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_days_ago": 0,
  "activities": 0,
  "repetition_rule": null,
  "board_remaining_time": null,
  "stage_depart_estimated_at": null,
  "is_urgent": false,
  "points": null,
  "reestimate_count": 0,
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "workflow_id": null,
  "checklist_id": null,
  "is_shared": false,
  "sharing_details": [

  ],
  "subtask_ids": [

  ],
  "subtasks_count": 0,
  "subtasks_closed_count": 0,
  "subtasks_count_progress": null,
  "is_subtask": false,
  "parent_task_id": null,
  "parent_task_title": null,
  "priority": 4,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "uid": 4,
  "responsible_id": "coyote-865",
  "task_state_id": 10,
  "responsible_name": "Coyote 865",
  "task_state_name": "Board Stage 805",
  "activities_7_days_ago": 0,
  "repetition_rule_id": null,
  "current_worked_time": 0,
  "estimated_delivery_date_updated": false,
  "last_estimated_at": null,
  "task_tags": [

  ],
  "approved": null,
  "task_status_id": 10,
  "task_status_name": "Board Stage 805",
  "assignments": [
    {
      "id": "1254deb6e4",
      "task_id": 4,
      "assignee_id": "coyote-865",
      "team_id": null,
      "assignee_name": "Coyote 865",
      "team_name": null,
      "queue_position": 2,
      "priority": 2,
      "current_estimate_seconds": 3600,
      "time_worked": 0,
      "estimated_start_date": null,
      "estimate_updated": false,
      "start_date": null,
      "close_date": null,
      "is_closed": false,
      "reestimate_count": 0,
      "is_working_on": false,
      "automatic_time_worked_updated_at": "2022-02-23T10:10:38-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-747/coyote-865/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-747/coyote-865/regular.png",
      "time_worked_not_persisted": 0
    }
  ],
  "follower_ids": [

  ]
}
POST

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

Share the task

Share the task with guests.

Parameters

Name Description type
id required

Task ID

integer

comment

string

guests_params

List of objects with guest data

array

sharing_details

List of optional information to be shared. Options: "documents", "time_progress", "board_stage"

array

Request

Route

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

Headers

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

Body

{
  "sharing_details": [
    "documents"
  ],
  "guests_params": [
    {
      "email": "guest1@email.com"
    },
    {
      "email": "guest2@email.com"
    }
  ]
}

cURL

curl "https://runrun.it/api/v1.0/tasks/1/share" -d '{"sharing_details":["documents"],"guests_params":[{"email":"guest1@email.com"},{"email":"guest2@email.com"}]}' -X POST \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": 1,
  "title": "Bla",
  "is_working_on": false,
  "user_id": "coyote-872",
  "type_id": 1,
  "project_id": 1,
  "team_id": null,
  "board_id": 1,
  "board_stage_id": 1,
  "board_stage_position": 70368744177664,
  "subtask_parent_position": null,
  "desired_date": null,
  "desired_date_with_time": null,
  "estimated_start_date": null,
  "estimated_delivery_date": null,
  "gantt_bar_start_date": null,
  "gantt_bar_end_date": null,
  "close_date": null,
  "was_reopened": false,
  "is_closed": false,
  "is_assigned": true,
  "on_going": false,
  "estimate_updated": false,
  "estimated_at": null,
  "queue_position": 1,
  "created_at": "2022-04-14T18:11:18-03:00",
  "start_date": null,
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "current_evaluator_id": null,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 302",
  "client_id": 1,
  "project_name": "Test project 273",
  "project_group_name": "Sem grupo",
  "project_group_id": 1,
  "project_group_is_default": true,
  "project_sub_group_name": "Sem subgrupo",
  "project_sub_group_id": 1,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 322",
  "user_name": "Coyote 872",
  "board_name": "Board 273",
  "board_stage_name": "Board Stage 820",
  "team_name": null,
  "type_color": "FFFFFF",
  "state": "queued",
  "overdue": "on_schedule",
  "time_worked": 0,
  "time_pending": 3600,
  "time_total": 3600,
  "time_progress": 0.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_days_ago": 0,
  "activities": 0,
  "repetition_rule": null,
  "board_remaining_time": null,
  "stage_depart_estimated_at": null,
  "is_urgent": false,
  "points": null,
  "reestimate_count": 0,
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "workflow_id": null,
  "checklist_id": null,
  "is_shared": true,
  "sharing_details": [
    "documents"
  ],
  "subtask_ids": [

  ],
  "subtasks_count": 0,
  "subtasks_closed_count": 0,
  "subtasks_count_progress": null,
  "is_subtask": false,
  "parent_task_id": null,
  "parent_task_title": null,
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "uid": 1,
  "responsible_id": "coyote-871",
  "task_state_id": 1,
  "responsible_name": "Coyote 871",
  "task_state_name": "Board Stage 820",
  "activities_7_days_ago": 0,
  "repetition_rule_id": null,
  "current_worked_time": 0,
  "estimated_delivery_date_updated": false,
  "last_estimated_at": null,
  "task_tags": [

  ],
  "approved": null,
  "task_status_id": 1,
  "task_status_name": "Board Stage 820",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-871",
      "team_id": null,
      "assignee_name": "Coyote 871",
      "team_name": null,
      "queue_position": 1,
      "priority": 1,
      "current_estimate_seconds": 3600,
      "time_worked": 0,
      "estimated_start_date": null,
      "estimate_updated": false,
      "start_date": null,
      "close_date": null,
      "is_closed": false,
      "reestimate_count": 0,
      "is_working_on": false,
      "automatic_time_worked_updated_at": "2022-04-14T18:11:18-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-748/coyote-871/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-748/coyote-871/regular.png",
      "time_worked_not_persisted": 0
    }
  ],
  "follower_ids": [

  ]
}

Request

Route

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

Headers

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

Body

{
  "sharing_details": [
    "documents",
    "time_progress"
  ],
  "guests_params": [
    {
      "email": "guest2@email.com"
    },
    {
      "email": "guest3@email.com"
    }
  ]
}

cURL

curl "https://runrun.it/api/v1.0/tasks/1/share" -d '{"sharing_details":["documents","time_progress"],"guests_params":[{"email":"guest2@email.com"},{"email":"guest3@email.com"}]}' -X POST \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": 1,
  "title": "Bla",
  "is_working_on": false,
  "user_id": "coyote-872",
  "type_id": 1,
  "project_id": 1,
  "team_id": null,
  "board_id": 1,
  "board_stage_id": 1,
  "board_stage_position": 70368744177664,
  "subtask_parent_position": null,
  "desired_date": null,
  "desired_date_with_time": null,
  "estimated_start_date": null,
  "estimated_delivery_date": null,
  "gantt_bar_start_date": null,
  "gantt_bar_end_date": null,
  "close_date": null,
  "was_reopened": false,
  "is_closed": false,
  "is_assigned": true,
  "on_going": false,
  "estimate_updated": false,
  "estimated_at": null,
  "queue_position": 1,
  "created_at": "2022-04-14T18:11:18-03:00",
  "start_date": null,
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "current_evaluator_id": null,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 302",
  "client_id": 1,
  "project_name": "Test project 273",
  "project_group_name": "Sem grupo",
  "project_group_id": 1,
  "project_group_is_default": true,
  "project_sub_group_name": "Sem subgrupo",
  "project_sub_group_id": 1,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 322",
  "user_name": "Coyote 872",
  "board_name": "Board 273",
  "board_stage_name": "Board Stage 820",
  "team_name": null,
  "type_color": "FFFFFF",
  "state": "queued",
  "overdue": "on_schedule",
  "time_worked": 0,
  "time_pending": 3600,
  "time_total": 3600,
  "time_progress": 0.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_days_ago": 0,
  "activities": 0,
  "repetition_rule": null,
  "board_remaining_time": null,
  "stage_depart_estimated_at": null,
  "is_urgent": false,
  "points": null,
  "reestimate_count": 0,
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "workflow_id": null,
  "checklist_id": null,
  "is_shared": true,
  "sharing_details": [
    "documents",
    "time_progress"
  ],
  "subtask_ids": [

  ],
  "subtasks_count": 0,
  "subtasks_closed_count": 0,
  "subtasks_count_progress": null,
  "is_subtask": false,
  "parent_task_id": null,
  "parent_task_title": null,
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "uid": 1,
  "responsible_id": "coyote-871",
  "task_state_id": 1,
  "responsible_name": "Coyote 871",
  "task_state_name": "Board Stage 820",
  "activities_7_days_ago": 0,
  "repetition_rule_id": null,
  "current_worked_time": 0,
  "estimated_delivery_date_updated": false,
  "last_estimated_at": null,
  "task_tags": [

  ],
  "approved": null,
  "task_status_id": 1,
  "task_status_name": "Board Stage 820",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-871",
      "team_id": null,
      "assignee_name": "Coyote 871",
      "team_name": null,
      "queue_position": 1,
      "priority": 1,
      "current_estimate_seconds": 3600,
      "time_worked": 0,
      "estimated_start_date": null,
      "estimate_updated": false,
      "start_date": null,
      "close_date": null,
      "is_closed": false,
      "reestimate_count": 0,
      "is_working_on": false,
      "automatic_time_worked_updated_at": "2022-04-14T18:11:18-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-748/coyote-871/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-748/coyote-871/regular.png",
      "time_worked_not_persisted": 0
    }
  ],
  "follower_ids": [

  ]
}

Request

Route

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

Headers

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

Body

{
  "sharing_details": [

  ],
  "guests_params": [

  ]
}

cURL

curl "https://runrun.it/api/v1.0/tasks/1/share" -d '{"sharing_details":[],"guests_params":[]}' -X POST \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": 1,
  "title": "Bla",
  "is_working_on": false,
  "user_id": "coyote-872",
  "type_id": 1,
  "project_id": 1,
  "team_id": null,
  "board_id": 1,
  "board_stage_id": 1,
  "board_stage_position": 70368744177664,
  "subtask_parent_position": null,
  "desired_date": null,
  "desired_date_with_time": null,
  "estimated_start_date": null,
  "estimated_delivery_date": null,
  "gantt_bar_start_date": null,
  "gantt_bar_end_date": null,
  "close_date": null,
  "was_reopened": false,
  "is_closed": false,
  "is_assigned": true,
  "on_going": false,
  "estimate_updated": false,
  "estimated_at": null,
  "queue_position": 1,
  "created_at": "2022-04-14T18:11:18-03:00",
  "start_date": null,
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "current_evaluator_id": null,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 302",
  "client_id": 1,
  "project_name": "Test project 273",
  "project_group_name": "Sem grupo",
  "project_group_id": 1,
  "project_group_is_default": true,
  "project_sub_group_name": "Sem subgrupo",
  "project_sub_group_id": 1,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 322",
  "user_name": "Coyote 872",
  "board_name": "Board 273",
  "board_stage_name": "Board Stage 820",
  "team_name": null,
  "type_color": "FFFFFF",
  "state": "queued",
  "overdue": "on_schedule",
  "time_worked": 0,
  "time_pending": 3600,
  "time_total": 3600,
  "time_progress": 0.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_days_ago": 0,
  "activities": 0,
  "repetition_rule": null,
  "board_remaining_time": null,
  "stage_depart_estimated_at": null,
  "is_urgent": false,
  "points": null,
  "reestimate_count": 0,
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "workflow_id": null,
  "checklist_id": null,
  "is_shared": true,
  "sharing_details": [

  ],
  "subtask_ids": [

  ],
  "subtasks_count": 0,
  "subtasks_closed_count": 0,
  "subtasks_count_progress": null,
  "is_subtask": false,
  "parent_task_id": null,
  "parent_task_title": null,
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "uid": 1,
  "responsible_id": "coyote-871",
  "task_state_id": 1,
  "responsible_name": "Coyote 871",
  "task_state_name": "Board Stage 820",
  "activities_7_days_ago": 0,
  "repetition_rule_id": null,
  "current_worked_time": 0,
  "estimated_delivery_date_updated": false,
  "last_estimated_at": null,
  "task_tags": [

  ],
  "approved": null,
  "task_status_id": 1,
  "task_status_name": "Board Stage 820",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-871",
      "team_id": null,
      "assignee_name": "Coyote 871",
      "team_name": null,
      "queue_position": 1,
      "priority": 1,
      "current_estimate_seconds": 3600,
      "time_worked": 0,
      "estimated_start_date": null,
      "estimate_updated": false,
      "start_date": null,
      "close_date": null,
      "is_closed": false,
      "reestimate_count": 0,
      "is_working_on": false,
      "automatic_time_worked_updated_at": "2022-04-14T18:11:18-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-748/coyote-871/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-748/coyote-871/regular.png",
      "time_worked_not_persisted": 0
    }
  ],
  "follower_ids": [

  ]
}
POST

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

Unshare the task

Parameters

Name Description type
id required

Task ID

integer

Request

Route

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

Headers

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

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": 1,
  "title": "Bla",
  "is_working_on": false,
  "user_id": "coyote-874",
  "type_id": 1,
  "project_id": 1,
  "team_id": null,
  "board_id": 1,
  "board_stage_id": 1,
  "board_stage_position": 70368744177664,
  "subtask_parent_position": null,
  "desired_date": null,
  "desired_date_with_time": null,
  "estimated_start_date": null,
  "estimated_delivery_date": null,
  "gantt_bar_start_date": null,
  "gantt_bar_end_date": null,
  "close_date": null,
  "was_reopened": false,
  "is_closed": false,
  "is_assigned": true,
  "on_going": false,
  "estimate_updated": false,
  "estimated_at": null,
  "queue_position": 1,
  "created_at": "2022-04-14T18:11:23-03:00",
  "start_date": null,
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "current_evaluator_id": null,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 303",
  "client_id": 1,
  "project_name": "Test project 274",
  "project_group_name": "Sem grupo",
  "project_group_id": 1,
  "project_group_is_default": true,
  "project_sub_group_name": "Sem subgrupo",
  "project_sub_group_id": 1,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 323",
  "user_name": "Coyote 874",
  "board_name": "Board 274",
  "board_stage_name": "Board Stage 823",
  "team_name": null,
  "type_color": "FFFFFF",
  "state": "queued",
  "overdue": "on_schedule",
  "time_worked": 0,
  "time_pending": 3600,
  "time_total": 3600,
  "time_progress": 0.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_days_ago": 0,
  "activities": 0,
  "repetition_rule": null,
  "board_remaining_time": null,
  "stage_depart_estimated_at": null,
  "is_urgent": false,
  "points": null,
  "reestimate_count": 0,
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "workflow_id": null,
  "checklist_id": null,
  "is_shared": false,
  "sharing_details": [

  ],
  "subtask_ids": [

  ],
  "subtasks_count": 0,
  "subtasks_closed_count": 0,
  "subtasks_count_progress": null,
  "is_subtask": false,
  "parent_task_id": null,
  "parent_task_title": null,
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "uid": 1,
  "responsible_id": "coyote-873",
  "task_state_id": 1,
  "responsible_name": "Coyote 873",
  "task_state_name": "Board Stage 823",
  "activities_7_days_ago": 0,
  "repetition_rule_id": null,
  "current_worked_time": 0,
  "estimated_delivery_date_updated": false,
  "last_estimated_at": null,
  "task_tags": [

  ],
  "approved": null,
  "task_status_id": 1,
  "task_status_name": "Board Stage 823",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-873",
      "team_id": null,
      "assignee_name": "Coyote 873",
      "team_name": null,
      "queue_position": 1,
      "priority": 1,
      "current_estimate_seconds": 3600,
      "time_worked": 0,
      "estimated_start_date": null,
      "estimate_updated": false,
      "start_date": null,
      "close_date": null,
      "is_closed": false,
      "reestimate_count": 0,
      "is_working_on": false,
      "automatic_time_worked_updated_at": "2022-04-14T18:11:23-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-749/coyote-873/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-749/coyote-873/regular.png",
      "time_worked_not_persisted": 0
    }
  ],
  "follower_ids": [

  ]
}
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=1%2C2

Headers

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

Query Parameters

task_ids=1,2

cURL

curl "https://runrun.it/api/v1.0/tasks/unseen_activities?task_ids=1%2C2" -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

200

Headers

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

Body

[
  {
    "task_id": 1,
    "has_unread_comments": false
  },
  {
    "task_id": 2,
    "has_unread_comments": false
  }
]
POST

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

Complete a workflow step

Parameters

Name Description type
id

Task ID

integer

Request

Route

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

Headers

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

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": 1,
  "title": "Bla",
  "is_working_on": false,
  "user_id": "coyote-885",
  "type_id": 1,
  "project_id": 1,
  "team_id": null,
  "board_id": 1,
  "board_stage_id": 1,
  "board_stage_position": 70368744177664,
  "subtask_parent_position": null,
  "desired_date": null,
  "desired_date_with_time": null,
  "estimated_start_date": null,
  "estimated_delivery_date": null,
  "gantt_bar_start_date": null,
  "gantt_bar_end_date": null,
  "close_date": null,
  "was_reopened": false,
  "is_closed": false,
  "is_assigned": true,
  "on_going": false,
  "estimate_updated": false,
  "estimated_at": null,
  "queue_position": 1,
  "created_at": "2022-02-23T10:10:58-03:00",
  "start_date": null,
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "current_evaluator_id": null,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 308",
  "client_id": 1,
  "project_name": "Test project 279",
  "project_group_name": "Sem grupo",
  "project_group_id": 1,
  "project_group_is_default": true,
  "project_sub_group_name": "Sem subgrupo",
  "project_sub_group_id": 1,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 328",
  "user_name": "Coyote 885",
  "board_name": "Board 279",
  "board_stage_name": "Board Stage 838",
  "team_name": null,
  "type_color": "FFFFFF",
  "state": "queued",
  "overdue": "on_schedule",
  "time_worked": 0,
  "time_pending": 3600,
  "time_total": 3600,
  "time_progress": 0.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_days_ago": 0,
  "activities": 0,
  "repetition_rule": null,
  "board_remaining_time": null,
  "stage_depart_estimated_at": null,
  "is_urgent": false,
  "points": null,
  "reestimate_count": 0,
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "workflow_id": 1,
  "checklist_id": null,
  "is_shared": false,
  "sharing_details": [

  ],
  "subtask_ids": [

  ],
  "subtasks_count": 0,
  "subtasks_closed_count": 0,
  "subtasks_count_progress": null,
  "is_subtask": false,
  "parent_task_id": null,
  "parent_task_title": null,
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "uid": 1,
  "responsible_id": "coyote-887",
  "task_state_id": 1,
  "responsible_name": "Coyote 887",
  "task_state_name": "Board Stage 838",
  "activities_7_days_ago": 0,
  "repetition_rule_id": null,
  "current_worked_time": 0,
  "estimated_delivery_date_updated": false,
  "last_estimated_at": null,
  "task_tags": [

  ],
  "approved": null,
  "task_status_id": 1,
  "task_status_name": "Board Stage 838",
  "assignments": [
    {
      "id": "92a6f5b72",
      "task_id": 1,
      "assignee_id": "coyote-887",
      "team_id": null,
      "assignee_name": "Coyote 887",
      "team_name": null,
      "queue_position": 1,
      "priority": 1,
      "current_estimate_seconds": 3600,
      "time_worked": 0,
      "estimated_start_date": null,
      "estimate_updated": false,
      "start_date": null,
      "close_date": null,
      "is_closed": false,
      "reestimate_count": 0,
      "is_working_on": false,
      "automatic_time_worked_updated_at": "2022-02-23T10:10:59-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-756/coyote-887/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-756/coyote-887/regular.png",
      "time_worked_not_persisted": 0
    }
  ],
  "follower_ids": [
    "coyote-885"
  ]
}
POST

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

Undo a workflow step

Parameters

Name Description type
id

Task ID

integer

Request

Route

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

Headers

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

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": 1,
  "title": "Bla",
  "is_working_on": false,
  "user_id": "coyote-891",
  "type_id": 1,
  "project_id": 1,
  "team_id": 1,
  "board_id": 1,
  "board_stage_id": 1,
  "board_stage_position": 70368744177664,
  "subtask_parent_position": null,
  "desired_date": null,
  "desired_date_with_time": null,
  "estimated_start_date": null,
  "estimated_delivery_date": null,
  "gantt_bar_start_date": null,
  "gantt_bar_end_date": null,
  "close_date": null,
  "was_reopened": false,
  "is_closed": false,
  "is_assigned": true,
  "on_going": false,
  "estimate_updated": false,
  "estimated_at": null,
  "queue_position": 1,
  "created_at": "2022-02-23T10:11:02-03:00",
  "start_date": null,
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "current_evaluator_id": null,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 309",
  "client_id": 1,
  "project_name": "Test project 280",
  "project_group_name": "Sem grupo",
  "project_group_id": 1,
  "project_group_is_default": true,
  "project_sub_group_name": "Sem subgrupo",
  "project_sub_group_id": 1,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 329",
  "user_name": "Coyote 891",
  "board_name": "Board 280",
  "board_stage_name": "Board Stage 841",
  "team_name": "Test team 65",
  "type_color": "FFFFFF",
  "state": "queued",
  "overdue": "on_schedule",
  "time_worked": 0,
  "time_pending": 3600,
  "time_total": 3600,
  "time_progress": 0.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_days_ago": 0,
  "activities": 0,
  "repetition_rule": null,
  "board_remaining_time": null,
  "stage_depart_estimated_at": null,
  "is_urgent": false,
  "points": null,
  "reestimate_count": 0,
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "workflow_id": 1,
  "checklist_id": null,
  "is_shared": false,
  "sharing_details": [

  ],
  "subtask_ids": [

  ],
  "subtasks_count": 0,
  "subtasks_closed_count": 0,
  "subtasks_count_progress": null,
  "is_subtask": false,
  "parent_task_id": null,
  "parent_task_title": null,
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "uid": 1,
  "responsible_id": "coyote-890",
  "task_state_id": 1,
  "responsible_name": "Coyote 890",
  "task_state_name": "Board Stage 841",
  "activities_7_days_ago": 0,
  "repetition_rule_id": null,
  "current_worked_time": 0,
  "estimated_delivery_date_updated": false,
  "last_estimated_at": null,
  "task_tags": [

  ],
  "approved": null,
  "task_status_id": 1,
  "task_status_name": "Board Stage 841",
  "assignments": [
    {
      "id": "dbfa7092b",
      "task_id": 1,
      "assignee_id": "coyote-890",
      "team_id": 1,
      "assignee_name": "Coyote 890",
      "team_name": "Test team 65",
      "queue_position": 1,
      "priority": 1,
      "current_estimate_seconds": 3600,
      "time_worked": 0,
      "estimated_start_date": null,
      "estimate_updated": false,
      "start_date": null,
      "close_date": null,
      "is_closed": false,
      "reestimate_count": 0,
      "is_working_on": false,
      "automatic_time_worked_updated_at": "2022-02-23T10:11:03-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-758/coyote-890/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-758/coyote-890/regular.png",
      "time_worked_not_persisted": 0
    }
  ],
  "follower_ids": [
    "coyote-888",
    "coyote-890"
  ]
}
POST

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

Mark a task as urgent

Parameters

Name Description type
id

Task ID

integer

Request

Route

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

Headers

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

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": 1,
  "title": "Bla",
  "is_working_on": false,
  "user_id": "coyote-905",
  "type_id": 1,
  "project_id": 1,
  "team_id": null,
  "board_id": 1,
  "board_stage_id": 1,
  "board_stage_position": 70368744177664,
  "subtask_parent_position": null,
  "desired_date": null,
  "desired_date_with_time": null,
  "estimated_start_date": null,
  "estimated_delivery_date": null,
  "gantt_bar_start_date": null,
  "gantt_bar_end_date": null,
  "close_date": null,
  "was_reopened": false,
  "is_closed": false,
  "is_assigned": true,
  "on_going": false,
  "estimate_updated": false,
  "estimated_at": null,
  "queue_position": 1,
  "created_at": "2022-02-23T10:11:14-03:00",
  "start_date": null,
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "current_evaluator_id": null,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 314",
  "client_id": 1,
  "project_name": "Test project 285",
  "project_group_name": "Sem grupo",
  "project_group_id": 1,
  "project_group_is_default": true,
  "project_sub_group_name": "Sem subgrupo",
  "project_sub_group_id": 1,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 334",
  "user_name": "Coyote 905",
  "board_name": "Board 285",
  "board_stage_name": "Board Stage 856",
  "team_name": null,
  "type_color": "FFFFFF",
  "state": "queued",
  "overdue": "on_schedule",
  "time_worked": 0,
  "time_pending": 3600,
  "time_total": 3600,
  "time_progress": 0.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_days_ago": 0,
  "activities": 0,
  "repetition_rule": null,
  "board_remaining_time": null,
  "stage_depart_estimated_at": null,
  "is_urgent": true,
  "points": null,
  "reestimate_count": 0,
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "workflow_id": null,
  "checklist_id": null,
  "is_shared": false,
  "sharing_details": [

  ],
  "subtask_ids": [

  ],
  "subtasks_count": 0,
  "subtasks_closed_count": 0,
  "subtasks_count_progress": null,
  "is_subtask": false,
  "parent_task_id": null,
  "parent_task_title": null,
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "uid": 1,
  "responsible_id": "coyote-904",
  "task_state_id": 1,
  "responsible_name": "Coyote 904",
  "task_state_name": "Board Stage 856",
  "activities_7_days_ago": 0,
  "repetition_rule_id": null,
  "current_worked_time": 0,
  "estimated_delivery_date_updated": false,
  "last_estimated_at": null,
  "task_tags": [

  ],
  "approved": null,
  "task_status_id": 1,
  "task_status_name": "Board Stage 856",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-904",
      "team_id": null,
      "assignee_name": "Coyote 904",
      "team_name": null,
      "queue_position": 1,
      "priority": 1,
      "current_estimate_seconds": 3600,
      "time_worked": 0,
      "estimated_start_date": null,
      "estimate_updated": false,
      "start_date": null,
      "close_date": null,
      "is_closed": false,
      "reestimate_count": 0,
      "is_working_on": false,
      "automatic_time_worked_updated_at": "2022-02-23T10:11:14-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-764/coyote-904/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-764/coyote-904/regular.png",
      "time_worked_not_persisted": 0
    }
  ],
  "follower_ids": [

  ]
}
POST

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

Unmark a task as urgent

Parameters

Name Description type
id

Task ID

integer

Request

Route

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

Headers

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

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": 1,
  "title": "Bla",
  "is_working_on": false,
  "user_id": "coyote-907",
  "type_id": 1,
  "project_id": 1,
  "team_id": null,
  "board_id": 1,
  "board_stage_id": 1,
  "board_stage_position": 70368744177664,
  "subtask_parent_position": null,
  "desired_date": null,
  "desired_date_with_time": null,
  "estimated_start_date": null,
  "estimated_delivery_date": null,
  "gantt_bar_start_date": null,
  "gantt_bar_end_date": null,
  "close_date": null,
  "was_reopened": false,
  "is_closed": false,
  "is_assigned": true,
  "on_going": false,
  "estimate_updated": false,
  "estimated_at": null,
  "queue_position": 1,
  "created_at": "2022-02-23T10:11:16-03:00",
  "start_date": null,
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "current_evaluator_id": null,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 315",
  "client_id": 1,
  "project_name": "Test project 286",
  "project_group_name": "Sem grupo",
  "project_group_id": 1,
  "project_group_is_default": true,
  "project_sub_group_name": "Sem subgrupo",
  "project_sub_group_id": 1,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 335",
  "user_name": "Coyote 907",
  "board_name": "Board 286",
  "board_stage_name": "Board Stage 859",
  "team_name": null,
  "type_color": "FFFFFF",
  "state": "queued",
  "overdue": "on_schedule",
  "time_worked": 0,
  "time_pending": 3600,
  "time_total": 3600,
  "time_progress": 0.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_days_ago": 0,
  "activities": 0,
  "repetition_rule": null,
  "board_remaining_time": null,
  "stage_depart_estimated_at": null,
  "is_urgent": false,
  "points": null,
  "reestimate_count": 0,
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "workflow_id": null,
  "checklist_id": null,
  "is_shared": false,
  "sharing_details": [

  ],
  "subtask_ids": [

  ],
  "subtasks_count": 0,
  "subtasks_closed_count": 0,
  "subtasks_count_progress": null,
  "is_subtask": false,
  "parent_task_id": null,
  "parent_task_title": null,
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "uid": 1,
  "responsible_id": "coyote-906",
  "task_state_id": 1,
  "responsible_name": "Coyote 906",
  "task_state_name": "Board Stage 859",
  "activities_7_days_ago": 0,
  "repetition_rule_id": null,
  "current_worked_time": 0,
  "estimated_delivery_date_updated": false,
  "last_estimated_at": null,
  "task_tags": [

  ],
  "approved": null,
  "task_status_id": 1,
  "task_status_name": "Board Stage 859",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-906",
      "team_id": null,
      "assignee_name": "Coyote 906",
      "team_name": null,
      "queue_position": 1,
      "priority": 1,
      "current_estimate_seconds": 3600,
      "time_worked": 0,
      "estimated_start_date": null,
      "estimate_updated": false,
      "start_date": null,
      "close_date": null,
      "is_closed": false,
      "reestimate_count": 0,
      "is_working_on": false,
      "automatic_time_worked_updated_at": "2022-02-23T10:11:16-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-765/coyote-906/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-765/coyote-906/regular.png",
      "time_worked_not_persisted": 0
    }
  ],
  "follower_ids": [

  ]
}
POST

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

Create a task assignment for another user

Create a task assignment based on a task.

Parameters

Name Description type
id required

Task ID

integer

assignments

Request

Route

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

Headers

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

Body

{
  "assignments": [
    {
      "assignee_id": "coyote-909",
      "team_id": 1
    }
  ]
}

cURL

curl "https://runrun.it/api/v1.0/tasks/1/create_assignments" -d '{"assignments":[{"assignee_id":"coyote-909","team_id":1}]}' -X POST \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": 1,
  "title": "Bla",
  "is_working_on": false,
  "user_id": "coyote-911",
  "type_id": 1,
  "project_id": 1,
  "team_id": null,
  "board_id": 1,
  "board_stage_id": 1,
  "board_stage_position": 70368744177664,
  "subtask_parent_position": null,
  "desired_date": null,
  "desired_date_with_time": null,
  "estimated_start_date": null,
  "estimated_delivery_date": null,
  "gantt_bar_start_date": null,
  "gantt_bar_end_date": null,
  "close_date": null,
  "was_reopened": false,
  "is_closed": false,
  "is_assigned": true,
  "on_going": false,
  "estimate_updated": false,
  "estimated_at": null,
  "queue_position": null,
  "created_at": "2022-02-23T10:11:19-03:00",
  "start_date": null,
  "desired_start_date": null,
  "current_estimate_seconds": 7200,
  "current_evaluator_id": null,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 316",
  "client_id": 1,
  "project_name": "Test project 287",
  "project_group_name": "Sem grupo",
  "project_group_id": 1,
  "project_group_is_default": true,
  "project_sub_group_name": "Sem subgrupo",
  "project_sub_group_id": 1,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 336",
  "user_name": "Coyote 911",
  "board_name": "Board 287",
  "board_stage_name": "Board Stage 862",
  "team_name": null,
  "type_color": "FFFFFF",
  "state": "queued",
  "overdue": "on_schedule",
  "time_worked": 0,
  "time_pending": 7200,
  "time_total": 7200,
  "time_progress": 0.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_days_ago": 0,
  "activities": 0,
  "repetition_rule": null,
  "board_remaining_time": null,
  "stage_depart_estimated_at": null,
  "is_urgent": false,
  "points": null,
  "reestimate_count": 0,
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "workflow_id": null,
  "checklist_id": null,
  "is_shared": false,
  "sharing_details": [

  ],
  "subtask_ids": [

  ],
  "subtasks_count": 0,
  "subtasks_closed_count": 0,
  "subtasks_count_progress": null,
  "is_subtask": false,
  "parent_task_id": null,
  "parent_task_title": null,
  "priority": null,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "uid": 1,
  "responsible_id": "coyote-908",
  "task_state_id": 1,
  "responsible_name": "Coyote 908",
  "task_state_name": "Board Stage 862",
  "activities_7_days_ago": 0,
  "repetition_rule_id": null,
  "current_worked_time": 0,
  "estimated_delivery_date_updated": false,
  "last_estimated_at": null,
  "task_tags": [

  ],
  "approved": null,
  "task_status_id": 1,
  "task_status_name": "Board Stage 862",
  "assignments": [
    {
      "id": "92a6f5b72",
      "task_id": 1,
      "assignee_id": "coyote-909",
      "team_id": 1,
      "assignee_name": "Coyote 909",
      "team_name": "Test team 66",
      "queue_position": 1,
      "priority": 1,
      "current_estimate_seconds": 3600,
      "time_worked": 0,
      "estimated_start_date": null,
      "estimate_updated": false,
      "start_date": null,
      "close_date": null,
      "is_closed": false,
      "reestimate_count": 0,
      "is_working_on": false,
      "automatic_time_worked_updated_at": "2022-02-23T10:11:19-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-766/coyote-909/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-766/coyote-909/regular.png",
      "time_worked_not_persisted": 0
    },
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-908",
      "team_id": null,
      "assignee_name": "Coyote 908",
      "team_name": null,
      "queue_position": 1,
      "priority": 1,
      "current_estimate_seconds": 3600,
      "time_worked": 0,
      "estimated_start_date": null,
      "estimate_updated": false,
      "start_date": null,
      "close_date": null,
      "is_closed": false,
      "reestimate_count": 0,
      "is_working_on": false,
      "automatic_time_worked_updated_at": "2022-02-23T10:11:19-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-766/coyote-908/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-766/coyote-908/regular.png",
      "time_worked_not_persisted": 0
    }
  ],
  "follower_ids": [

  ]
}
POST

/api/v1.0/tasks/clone

Clone a task

Parameters

Name Description
from_task_id

Request

Route

POST /api/v1.0/tasks/clone

Headers

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

Body

{
  "from_task_id": 1
}

cURL

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

Response

Simulated Response

Status

201

Headers

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

Body

{
  "id": 2,
  "title": "(cópia) Bla",
  "is_working_on": false,
  "user_id": "coyote-928",
  "type_id": 1,
  "project_id": 1,
  "team_id": null,
  "board_id": 1,
  "board_stage_id": 1,
  "board_stage_position": 70368744177665,
  "subtask_parent_position": null,
  "desired_date": null,
  "desired_date_with_time": null,
  "estimated_start_date": null,
  "estimated_delivery_date": null,
  "gantt_bar_start_date": null,
  "gantt_bar_end_date": null,
  "close_date": null,
  "was_reopened": false,
  "is_closed": false,
  "is_assigned": true,
  "on_going": false,
  "estimate_updated": true,
  "estimated_at": "2022-02-23T10:11:35-03:00",
  "queue_position": 2,
  "created_at": "2022-02-23T10:11:35-03:00",
  "start_date": null,
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "current_evaluator_id": null,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 322",
  "client_id": 1,
  "project_name": "Test project 293",
  "project_group_name": "Sem grupo",
  "project_group_id": 1,
  "project_group_is_default": true,
  "project_sub_group_name": "Sem subgrupo",
  "project_sub_group_id": 1,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 342",
  "user_name": "Coyote 928",
  "board_name": "Board 294",
  "board_stage_name": "Board Stage 884",
  "team_name": null,
  "type_color": "FFFFFF",
  "state": "queued",
  "overdue": "on_schedule",
  "time_worked": 0,
  "time_pending": 3600,
  "time_total": 3600,
  "time_progress": 0.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_days_ago": 0,
  "activities": 0,
  "repetition_rule": null,
  "board_remaining_time": null,
  "stage_depart_estimated_at": null,
  "is_urgent": false,
  "points": null,
  "reestimate_count": 0,
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "workflow_id": null,
  "checklist_id": null,
  "is_shared": false,
  "sharing_details": [

  ],
  "subtask_ids": [

  ],
  "subtasks_count": 0,
  "subtasks_closed_count": 0,
  "subtasks_count_progress": null,
  "is_subtask": false,
  "parent_task_id": null,
  "parent_task_title": null,
  "priority": 2,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "uid": 2,
  "responsible_id": "coyote-928",
  "task_state_id": 1,
  "responsible_name": "Coyote 928",
  "task_state_name": "Board Stage 884",
  "activities_7_days_ago": 0,
  "repetition_rule_id": null,
  "current_worked_time": 0,
  "estimated_delivery_date_updated": true,
  "last_estimated_at": "2022-02-23T10:11:35-03:00",
  "task_tags": [

  ],
  "approved": null,
  "task_status_id": 1,
  "task_status_name": "Board Stage 884",
  "assignments": [
    {
      "id": "92a6f5b72",
      "task_id": 2,
      "assignee_id": "coyote-928",
      "team_id": null,
      "assignee_name": "Coyote 928",
      "team_name": null,
      "queue_position": 2,
      "priority": 2,
      "current_estimate_seconds": 3600,
      "time_worked": 0,
      "estimated_start_date": null,
      "estimate_updated": false,
      "start_date": null,
      "close_date": null,
      "is_closed": false,
      "reestimate_count": 0,
      "is_working_on": false,
      "automatic_time_worked_updated_at": "2022-02-23T10:11:35-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-774/coyote-928/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-774/coyote-928/regular.png",
      "time_worked_not_persisted": 0
    }
  ],
  "follower_ids": [

  ]
}
POST

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

Move a task to next stage

Parameters

Name Description type
id

Task ID

integer

Request

Route

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

Headers

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

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": 1,
  "title": "Bla",
  "is_working_on": false,
  "user_id": "coyote-931",
  "type_id": 1,
  "project_id": 1,
  "team_id": null,
  "board_id": 1,
  "board_stage_id": 2,
  "board_stage_position": 70368744177664,
  "subtask_parent_position": null,
  "desired_date": null,
  "desired_date_with_time": null,
  "estimated_start_date": null,
  "estimated_delivery_date": null,
  "gantt_bar_start_date": null,
  "gantt_bar_end_date": null,
  "close_date": null,
  "was_reopened": false,
  "is_closed": false,
  "is_assigned": true,
  "on_going": false,
  "estimate_updated": true,
  "estimated_at": "2022-02-23T10:11:37-03:00",
  "queue_position": 1,
  "created_at": "2022-02-23T10:11:37-03:00",
  "start_date": null,
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "current_evaluator_id": null,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 323",
  "client_id": 1,
  "project_name": "Test project 294",
  "project_group_name": "Sem grupo",
  "project_group_id": 1,
  "project_group_is_default": true,
  "project_sub_group_name": "Sem subgrupo",
  "project_sub_group_id": 1,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 343",
  "user_name": "Coyote 931",
  "board_name": "Board 295",
  "board_stage_name": "Board Stage 888",
  "team_name": null,
  "type_color": "FFFFFF",
  "state": "queued",
  "overdue": "on_schedule",
  "time_worked": 0,
  "time_pending": 3600,
  "time_total": 3600,
  "time_progress": 0.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_days_ago": 0,
  "activities": 0,
  "repetition_rule": null,
  "board_remaining_time": null,
  "stage_depart_estimated_at": null,
  "is_urgent": false,
  "points": null,
  "reestimate_count": 0,
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "workflow_id": null,
  "checklist_id": null,
  "is_shared": false,
  "sharing_details": [

  ],
  "subtask_ids": [

  ],
  "subtasks_count": 0,
  "subtasks_closed_count": 0,
  "subtasks_count_progress": null,
  "is_subtask": false,
  "parent_task_id": null,
  "parent_task_title": null,
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "uid": 1,
  "responsible_id": "coyote-930",
  "task_state_id": 2,
  "responsible_name": "Coyote 930",
  "task_state_name": "Board Stage 888",
  "activities_7_days_ago": 0,
  "repetition_rule_id": null,
  "current_worked_time": 0,
  "estimated_delivery_date_updated": true,
  "last_estimated_at": "2022-02-23T10:11:37-03:00",
  "task_tags": [

  ],
  "approved": null,
  "task_status_id": 2,
  "task_status_name": "Board Stage 888",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-930",
      "team_id": null,
      "assignee_name": "Coyote 930",
      "team_name": null,
      "queue_position": 1,
      "priority": 1,
      "current_estimate_seconds": 3600,
      "time_worked": 0,
      "estimated_start_date": null,
      "estimate_updated": false,
      "start_date": null,
      "close_date": null,
      "is_closed": false,
      "reestimate_count": 0,
      "is_working_on": false,
      "automatic_time_worked_updated_at": "2022-02-23T10:11:37-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-775/coyote-930/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-775/coyote-930/regular.png",
      "time_worked_not_persisted": 0
    }
  ],
  "follower_ids": [

  ]
}

Request

Route

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

Headers

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

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": 1,
  "title": "Bla",
  "is_working_on": false,
  "user_id": "coyote-931",
  "type_id": 1,
  "project_id": 1,
  "team_id": null,
  "board_id": 1,
  "board_stage_id": 3,
  "board_stage_position": null,
  "subtask_parent_position": null,
  "desired_date": null,
  "desired_date_with_time": null,
  "estimated_start_date": null,
  "estimated_delivery_date": null,
  "gantt_bar_start_date": null,
  "gantt_bar_end_date": null,
  "close_date": "2022-02-23T10:11:37-03:00",
  "was_reopened": false,
  "is_closed": true,
  "is_assigned": true,
  "on_going": false,
  "estimate_updated": true,
  "estimated_at": "2022-02-23T10:11:37-03:00",
  "queue_position": null,
  "created_at": "2022-02-23T10:11:37-03:00",
  "start_date": "2022-02-23T10:11:37-03:00",
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "current_evaluator_id": null,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 323",
  "client_id": 1,
  "project_name": "Test project 294",
  "project_group_name": "Sem grupo",
  "project_group_id": 1,
  "project_group_is_default": true,
  "project_sub_group_name": "Sem subgrupo",
  "project_sub_group_id": 1,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 343",
  "user_name": "Coyote 931",
  "board_name": "Board 295",
  "board_stage_name": "Board Stage 889",
  "team_name": null,
  "type_color": "FFFFFF",
  "state": "closed",
  "overdue": "on_schedule",
  "time_worked": 0,
  "time_pending": 0,
  "time_total": 0,
  "time_progress": 0.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_days_ago": 0,
  "activities": 0,
  "repetition_rule": null,
  "board_remaining_time": 0,
  "stage_depart_estimated_at": null,
  "is_urgent": false,
  "points": null,
  "reestimate_count": 0,
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "workflow_id": null,
  "checklist_id": null,
  "is_shared": false,
  "sharing_details": [

  ],
  "subtask_ids": [

  ],
  "subtasks_count": 0,
  "subtasks_closed_count": 0,
  "subtasks_count_progress": null,
  "is_subtask": false,
  "parent_task_id": null,
  "parent_task_title": null,
  "priority": null,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "uid": 1,
  "responsible_id": "coyote-930",
  "task_state_id": 3,
  "responsible_name": "Coyote 930",
  "task_state_name": "Board Stage 889",
  "activities_7_days_ago": 0,
  "repetition_rule_id": null,
  "current_worked_time": 0,
  "estimated_delivery_date_updated": true,
  "last_estimated_at": "2022-02-23T10:11:37-03:00",
  "task_tags": [

  ],
  "approved": null,
  "task_status_id": 3,
  "task_status_name": "Board Stage 889",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-930",
      "team_id": null,
      "assignee_name": "Coyote 930",
      "team_name": null,
      "queue_position": null,
      "priority": null,
      "current_estimate_seconds": 3600,
      "time_worked": 0,
      "estimated_start_date": null,
      "estimate_updated": true,
      "start_date": "2022-02-23T10:11:37-03:00",
      "close_date": "2022-02-23T10:11:37-03:00",
      "is_closed": true,
      "reestimate_count": 0,
      "is_working_on": false,
      "automatic_time_worked_updated_at": "2022-02-23T10:11:37-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-775/coyote-930/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-775/coyote-930/regular.png",
      "time_worked_not_persisted": 0
    }
  ],
  "follower_ids": [

  ]
}

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://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

200

Headers

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

Body

[
  {
    "id": 1,
    "name": "Team1",
    "leader_id": "coyote-940",
    "leader_name": "Coyote 940",
    "cost_center": null,
    "user_ids": [
      "coyote-940"
    ],
    "master_user_id": "coyote-940",
    "master_user_name": "Coyote 940"
  }
]
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://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

200

Headers

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

Body

[
  {
    "id": 1,
    "name": "Team1",
    "leader_id": "coyote-943",
    "leader_name": "Coyote 943",
    "cost_center": null,
    "user_ids": [
      "coyote-943"
    ],
    "master_user_id": "coyote-943",
    "master_user_name": "Coyote 943"
  },
  {
    "id": 2,
    "name": "Team2",
    "leader_id": "coyote-943",
    "leader_name": "Coyote 943",
    "cost_center": null,
    "user_ids": [
      "coyote-943"
    ],
    "master_user_id": "coyote-943",
    "master_user_name": "Coyote 943"
  }
]
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://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

200

Headers

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

Body

[
  {
    "id": 2,
    "name": "Team2",
    "leader_id": "coyote-944",
    "leader_name": "Coyote 944",
    "cost_center": null,
    "user_ids": [
      "coyote-944"
    ],
    "master_user_id": "coyote-944",
    "master_user_name": "Coyote 944"
  }
]
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://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

200

Headers

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

Body

{
  "id": 1,
  "name": "Team1",
  "leader_id": "coyote-945",
  "leader_name": "Coyote 945",
  "cost_center": null,
  "user_ids": [
    "coyote-945"
  ],
  "master_user_id": "coyote-945",
  "master_user_name": "Coyote 945"
}
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]

[Deprecated] Use leader_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-946"
  }
}

cURL

curl "https://runrun.it/api/v1.0/teams" -d '{"team":{"name":"Team1","master_user_id":"coyote-946"}}' -X POST \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

201

Headers

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

Body

{
  "id": 1,
  "name": "Team1",
  "leader_id": "coyote-946",
  "leader_name": "Coyote 946",
  "cost_center": null,
  "user_ids": [
    "coyote-946"
  ],
  "master_user_id": "coyote-946",
  "master_user_name": "Coyote 946"
}
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]

[Deprecated] Use leader_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-948"
  }
}

cURL

curl "https://runrun.it/api/v1.0/teams/1" -d '{"team":{"name":"Team2","master_user_id":"coyote-948"}}' -X PUT \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": 1,
  "name": "Team2",
  "leader_id": "coyote-948",
  "leader_name": "Coyote 948",
  "cost_center": null,
  "user_ids": [
    "coyote-947",
    "coyote-948"
  ],
  "master_user_id": "coyote-948",
  "master_user_name": "Coyote 948"
}
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://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

204

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://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

200

Headers

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

Body

{
  "open_tasks": 0,
  "working_tasks": 0,
  "ratings_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-955"
}

cURL

curl "https://runrun.it/api/v1.0/teams/1/add_member" -d '{"user_id":"coyote-955"}' -X POST \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": 1,
  "name": "Team1",
  "leader_id": "coyote-954",
  "leader_name": "Coyote 954",
  "cost_center": null,
  "user_ids": [
    "coyote-954",
    "coyote-955"
  ],
  "master_user_id": "coyote-954",
  "master_user_name": "Coyote 954"
}
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-957"
}

cURL

curl "https://runrun.it/api/v1.0/teams/1/remove_member" -d '{"user_id":"coyote-957"}' -X POST \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": 1,
  "name": "Team1",
  "leader_id": "coyote-956",
  "leader_name": "Coyote 956",
  "cost_center": null,
  "user_ids": [
    "coyote-956"
  ],
  "master_user_id": "coyote-956",
  "master_user_name": "Coyote 956"
}

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-576

Headers

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

cURL

curl "https://runrun.it/api/v1.0/user_statistics/coyote-576" -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 integer

Status

200

Headers

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

Body

{
  "total": 341,
  "created_at": "2018-11-16T15:33:10-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://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
cost_hour Current user cost per hour decimal
is_master User is an administrator boolean
is_manager User is a manager boolean
is_auditor User is an auditor boolean
can_create_client_project_and_task_types User has permission to create client, projects and task types boolean
can_create_boards User has permission to create boards boolean
is_blocked_on_mobile User has mobile apps access blocked boolean
bypass_block_by_time_worked User ignore the blocking rule for time worked 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
created_at User creation date datetime
in_company_since Joining date in company date
is_certified Whether the user has passed Runrun.it certification boolean
language User preference language string
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
blocked_by_time_worked_at When the user is blocked for being out of the acceptable worked time defined by the company datetime
demanders_count Demanders count integer
partners_count Partners count integer
has_all_users_as_partners True if user has all users as partners boolean
has_all_users_as_demanders True if has all users as demanders boolean
password_updated_at Last time user password was updated datetime
password_expired_at Time when the user password was considered expired datetime
shift_work_time_per_week Shift work time (in seconds) per week integer
team_ids Ids from teams that the user belongs to array
led_team_ids Ids from teams the user leads array
legacy_on_vacation Internal use only boolean
skip_time_adjust_on_task_assignment_deliver User preference of skip adjust time modal on task deliver boolean
theme User preference of theme for interface between light or dark mode string
task_list_background_image_url Image url for background of task list string

Status

200

Headers

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

Body

[
  {
    "id": "coyote-964",
    "name": "Coyote 964",
    "email": "coyote950@acme.foo",
    "avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-798/coyote-964/mini.png",
    "avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-798/coyote-964/regular.png",
    "cost_hour": 0.0,
    "is_master": false,
    "is_manager": false,
    "is_auditor": false,
    "can_create_client_project_and_task_types": false,
    "can_create_boards": true,
    "is_blocked_on_mobile": false,
    "bypass_block_by_time_worked": false,
    "time_zone": "America/Sao_Paulo",
    "position": null,
    "on_vacation": false,
    "birthday": null,
    "phone": null,
    "gender": null,
    "marital_status": null,
    "created_at": "2022-02-23T10:12:16-03:00",
    "in_company_since": null,
    "is_certified": false,
    "language": "pt-BR",
    "alt_id": "802695411e7c47c3aae41f77acefd52e",
    "oid": "92a6f5b72",
    "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",
        "work_time": 0
      },
      {
        "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",
        "work_time": 28800
      },
      {
        "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",
        "work_time": 28800
      },
      {
        "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",
        "work_time": 28800
      },
      {
        "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",
        "work_time": 28800
      },
      {
        "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",
        "work_time": 28800
      },
      {
        "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",
        "work_time": 0
      }
    ],
    "is_mensurable": true,
    "time_tracking_mode": "smart",
    "blocked_by_time_worked_at": null,
    "demanders_count": 0,
    "partners_count": 0,
    "has_all_users_as_partners": false,
    "has_all_users_as_demanders": false,
    "password_updated_at": null,
    "password_expired_at": null,
    "shift_work_time_per_week": 144000,
    "team_ids": [

    ],
    "led_team_ids": [

    ],
    "skip_time_adjust_on_task_assignment_deliver": false,
    "theme": "light",
    "task_list_background_image_url": null
  },
  {
    "id": "coyote-963",
    "name": "Coyote 963",
    "email": "coyote949@acme.foo",
    "avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-798/coyote-963/mini.png",
    "avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-798/coyote-963/regular.png",
    "cost_hour": 0.0,
    "is_master": true,
    "is_manager": false,
    "is_auditor": false,
    "can_create_client_project_and_task_types": true,
    "can_create_boards": true,
    "is_blocked_on_mobile": false,
    "bypass_block_by_time_worked": false,
    "time_zone": "America/Sao_Paulo",
    "position": null,
    "on_vacation": false,
    "birthday": null,
    "phone": null,
    "gender": null,
    "marital_status": null,
    "created_at": "2022-02-23T10:12:16-03:00",
    "in_company_since": null,
    "is_certified": false,
    "language": "pt-BR",
    "alt_id": "89b36d700cedcdd7a538f0e725067f9a",
    "oid": "49537adb9",
    "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",
        "work_time": 0
      },
      {
        "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",
        "work_time": 28800
      },
      {
        "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",
        "work_time": 28800
      },
      {
        "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",
        "work_time": 28800
      },
      {
        "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",
        "work_time": 28800
      },
      {
        "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",
        "work_time": 28800
      },
      {
        "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",
        "work_time": 0
      }
    ],
    "is_mensurable": true,
    "time_tracking_mode": "smart",
    "blocked_by_time_worked_at": null,
    "demanders_count": 0,
    "partners_count": 0,
    "has_all_users_as_partners": false,
    "has_all_users_as_demanders": false,
    "password_updated_at": null,
    "password_expired_at": null,
    "shift_work_time_per_week": 144000,
    "team_ids": [

    ],
    "led_team_ids": [

    ],
    "skip_time_adjust_on_task_assignment_deliver": false,
    "theme": "light",
    "task_list_background_image_url": null
  }
]
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-965%2Ccoyote-966

Headers

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

Query Parameters

ids=coyote-965,coyote-966

cURL

curl "https://runrun.it/api/v1.0/users?ids=coyote-965%2Ccoyote-966" -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
cost_hour Current user cost per hour decimal
is_master User is an administrator boolean
is_manager User is a manager boolean
is_auditor User is an auditor boolean
can_create_client_project_and_task_types User has permission to create client, projects and task types boolean
can_create_boards User has permission to create boards boolean
is_blocked_on_mobile User has mobile apps access blocked boolean
bypass_block_by_time_worked User ignore the blocking rule for time worked 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
created_at User creation date datetime
in_company_since Joining date in company date
is_certified Whether the user has passed Runrun.it certification boolean
language User preference language string
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
blocked_by_time_worked_at When the user is blocked for being out of the acceptable worked time defined by the company datetime
demanders_count Demanders count integer
partners_count Partners count integer
has_all_users_as_partners True if user has all users as partners boolean
has_all_users_as_demanders True if has all users as demanders boolean
password_updated_at Last time user password was updated datetime
password_expired_at Time when the user password was considered expired datetime
shift_work_time_per_week Shift work time (in seconds) per week integer
team_ids Ids from teams that the user belongs to array
led_team_ids Ids from teams the user leads array
legacy_on_vacation Internal use only boolean
skip_time_adjust_on_task_assignment_deliver User preference of skip adjust time modal on task deliver boolean
theme User preference of theme for interface between light or dark mode string
task_list_background_image_url Image url for background of task list string

Status

200

Headers

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

Body

[
  {
    "id": "coyote-966",
    "name": "Coyote 966",
    "email": "coyote952@acme.foo",
    "avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-799/coyote-966/mini.png",
    "avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-799/coyote-966/regular.png",
    "cost_hour": 0.0,
    "is_master": false,
    "is_manager": false,
    "is_auditor": false,
    "can_create_client_project_and_task_types": false,
    "can_create_boards": true,
    "is_blocked_on_mobile": false,
    "bypass_block_by_time_worked": false,
    "time_zone": "America/Sao_Paulo",
    "position": null,
    "on_vacation": false,
    "birthday": null,
    "phone": null,
    "gender": null,
    "marital_status": null,
    "created_at": "2022-02-23T10:12:17-03:00",
    "in_company_since": null,
    "is_certified": false,
    "language": "pt-BR",
    "alt_id": "d1acc78c8a3c8ac3d7cc63cf21c11e0f",
    "oid": "92a6f5b72",
    "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",
        "work_time": 0
      },
      {
        "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",
        "work_time": 28800
      },
      {
        "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",
        "work_time": 28800
      },
      {
        "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",
        "work_time": 28800
      },
      {
        "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",
        "work_time": 28800
      },
      {
        "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",
        "work_time": 28800
      },
      {
        "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",
        "work_time": 0
      }
    ],
    "is_mensurable": true,
    "time_tracking_mode": "smart",
    "blocked_by_time_worked_at": null,
    "demanders_count": 0,
    "partners_count": 0,
    "has_all_users_as_partners": false,
    "has_all_users_as_demanders": false,
    "password_updated_at": null,
    "password_expired_at": null,
    "shift_work_time_per_week": 144000,
    "team_ids": [

    ],
    "led_team_ids": [

    ],
    "skip_time_adjust_on_task_assignment_deliver": false,
    "theme": "light",
    "task_list_background_image_url": null
  },
  {
    "id": "coyote-965",
    "name": "Coyote 965",
    "email": "coyote951@acme.foo",
    "avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-799/coyote-965/mini.png",
    "avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-799/coyote-965/regular.png",
    "cost_hour": 0.0,
    "is_master": true,
    "is_manager": false,
    "is_auditor": false,
    "can_create_client_project_and_task_types": true,
    "can_create_boards": true,
    "is_blocked_on_mobile": false,
    "bypass_block_by_time_worked": false,
    "time_zone": "America/Sao_Paulo",
    "position": null,
    "on_vacation": false,
    "birthday": null,
    "phone": null,
    "gender": null,
    "marital_status": null,
    "created_at": "2022-02-23T10:12:17-03:00",
    "in_company_since": null,
    "is_certified": false,
    "language": "pt-BR",
    "alt_id": "c158234040c68720dd8818583916a588",
    "oid": "49537adb9",
    "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",
        "work_time": 0
      },
      {
        "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",
        "work_time": 28800
      },
      {
        "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",
        "work_time": 28800
      },
      {
        "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",
        "work_time": 28800
      },
      {
        "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",
        "work_time": 28800
      },
      {
        "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",
        "work_time": 28800
      },
      {
        "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",
        "work_time": 0
      }
    ],
    "is_mensurable": true,
    "time_tracking_mode": "smart",
    "blocked_by_time_worked_at": null,
    "demanders_count": 0,
    "partners_count": 0,
    "has_all_users_as_partners": false,
    "has_all_users_as_demanders": false,
    "password_updated_at": null,
    "password_expired_at": null,
    "shift_work_time_per_week": 144000,
    "team_ids": [

    ],
    "led_team_ids": [

    ],
    "skip_time_adjust_on_task_assignment_deliver": false,
    "theme": "light",
    "task_list_background_image_url": null
  }
]
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://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
cost_hour Current user cost per hour decimal
is_master User is an administrator boolean
is_manager User is a manager boolean
is_auditor User is an auditor boolean
can_create_client_project_and_task_types User has permission to create client, projects and task types boolean
can_create_boards User has permission to create boards boolean
is_blocked_on_mobile User has mobile apps access blocked boolean
bypass_block_by_time_worked User ignore the blocking rule for time worked 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
created_at User creation date datetime
in_company_since Joining date in company date
is_certified Whether the user has passed Runrun.it certification boolean
language User preference language string
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
blocked_by_time_worked_at When the user is blocked for being out of the acceptable worked time defined by the company datetime
demanders_count Demanders count integer
partners_count Partners count integer
has_all_users_as_partners True if user has all users as partners boolean
has_all_users_as_demanders True if has all users as demanders boolean
password_updated_at Last time user password was updated datetime
password_expired_at Time when the user password was considered expired datetime
shift_work_time_per_week Shift work time (in seconds) per week integer
team_ids Ids from teams that the user belongs to array
led_team_ids Ids from teams the user leads array
legacy_on_vacation Internal use only boolean
skip_time_adjust_on_task_assignment_deliver User preference of skip adjust time modal on task deliver boolean
theme User preference of theme for interface between light or dark mode string
task_list_background_image_url Image url for background of task list string

Status

200

Headers

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

Body

[
  {
    "id": "coyote-969",
    "name": "Coyote 969",
    "email": "coyote955@acme.foo",
    "avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-800/coyote-969/mini.png",
    "avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-800/coyote-969/regular.png",
    "cost_hour": 0.0,
    "is_master": false,
    "is_manager": false,
    "is_auditor": false,
    "can_create_client_project_and_task_types": false,
    "can_create_boards": true,
    "is_blocked_on_mobile": false,
    "bypass_block_by_time_worked": false,
    "time_zone": "America/Sao_Paulo",
    "position": null,
    "on_vacation": false,
    "birthday": null,
    "phone": null,
    "gender": null,
    "marital_status": null,
    "created_at": "2022-02-23T10:12:19-03:00",
    "in_company_since": null,
    "is_certified": false,
    "language": "pt-BR",
    "alt_id": "cebc77cd1f2ed050db96eba90d49746d",
    "oid": "92a6f5b72",
    "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",
        "work_time": 0
      },
      {
        "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",
        "work_time": 28800
      },
      {
        "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",
        "work_time": 28800
      },
      {
        "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",
        "work_time": 28800
      },
      {
        "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",
        "work_time": 28800
      },
      {
        "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",
        "work_time": 28800
      },
      {
        "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",
        "work_time": 0
      }
    ],
    "is_mensurable": true,
    "time_tracking_mode": "smart",
    "blocked_by_time_worked_at": null,
    "demanders_count": 0,
    "partners_count": 0,
    "has_all_users_as_partners": false,
    "has_all_users_as_demanders": false,
    "password_updated_at": null,
    "password_expired_at": null,
    "shift_work_time_per_week": 144000,
    "team_ids": [
      1
    ],
    "led_team_ids": [

    ],
    "skip_time_adjust_on_task_assignment_deliver": false,
    "theme": "light",
    "task_list_background_image_url": null
  },
  {
    "id": "coyote-968",
    "name": "Coyote 968",
    "email": "coyote954@acme.foo",
    "avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-800/coyote-968/mini.png",
    "avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-800/coyote-968/regular.png",
    "cost_hour": 0.0,
    "is_master": true,
    "is_manager": false,
    "is_auditor": false,
    "can_create_client_project_and_task_types": true,
    "can_create_boards": true,
    "is_blocked_on_mobile": false,
    "bypass_block_by_time_worked": false,
    "time_zone": "America/Sao_Paulo",
    "position": null,
    "on_vacation": false,
    "birthday": null,
    "phone": null,
    "gender": null,
    "marital_status": null,
    "created_at": "2022-02-23T10:12:19-03:00",
    "in_company_since": null,
    "is_certified": false,
    "language": "pt-BR",
    "alt_id": "5614d4be30055e7c2c7f42fde1bee580",
    "oid": "49537adb9",
    "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",
        "work_time": 0
      },
      {
        "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",
        "work_time": 28800
      },
      {
        "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",
        "work_time": 28800
      },
      {
        "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",
        "work_time": 28800
      },
      {
        "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",
        "work_time": 28800
      },
      {
        "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",
        "work_time": 28800
      },
      {
        "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",
        "work_time": 0
      }
    ],
    "is_mensurable": true,
    "time_tracking_mode": "smart",
    "blocked_by_time_worked_at": null,
    "demanders_count": 0,
    "partners_count": 0,
    "has_all_users_as_partners": false,
    "has_all_users_as_demanders": false,
    "password_updated_at": null,
    "password_expired_at": null,
    "shift_work_time_per_week": 144000,
    "team_ids": [
      1
    ],
    "led_team_ids": [
      1
    ],
    "skip_time_adjust_on_task_assignment_deliver": false,
    "theme": "light",
    "task_list_background_image_url": null
  }
]
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+986

Headers

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

Query Parameters

search_term=Coyote 986

cURL

curl "https://runrun.it/api/v1.0/users?search_term=Coyote+986" -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
cost_hour Current user cost per hour decimal
is_master User is an administrator boolean
is_manager User is a manager boolean
is_auditor User is an auditor boolean
can_create_client_project_and_task_types User has permission to create client, projects and task types boolean
can_create_boards User has permission to create boards boolean
is_blocked_on_mobile User has mobile apps access blocked boolean
bypass_block_by_time_worked User ignore the blocking rule for time worked 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
created_at User creation date datetime
in_company_since Joining date in company date
is_certified Whether the user has passed Runrun.it certification boolean
language User preference language string
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
blocked_by_time_worked_at When the user is blocked for being out of the acceptable worked time defined by the company datetime
demanders_count Demanders count integer
partners_count Partners count integer
has_all_users_as_partners True if user has all users as partners boolean
has_all_users_as_demanders True if has all users as demanders boolean
password_updated_at Last time user password was updated datetime
password_expired_at Time when the user password was considered expired datetime
shift_work_time_per_week Shift work time (in seconds) per week integer
team_ids Ids from teams that the user belongs to array
led_team_ids Ids from teams the user leads array
legacy_on_vacation Internal use only boolean
skip_time_adjust_on_task_assignment_deliver User preference of skip adjust time modal on task deliver boolean
theme User preference of theme for interface between light or dark mode string
task_list_background_image_url Image url for background of task list string

Status

200

Headers

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

Body

[
  {
    "id": "coyote-986",
    "name": "Coyote 986",
    "email": "coyote972@acme.foo",
    "avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-804/coyote-986/mini.png",
    "avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-804/coyote-986/regular.png",
    "cost_hour": 0.0,
    "is_master": true,
    "is_manager": false,
    "is_auditor": false,
    "can_create_client_project_and_task_types": true,
    "can_create_boards": true,
    "is_blocked_on_mobile": false,
    "bypass_block_by_time_worked": false,
    "time_zone": "America/Sao_Paulo",
    "position": null,
    "on_vacation": false,
    "birthday": null,
    "phone": null,
    "gender": null,
    "marital_status": null,
    "created_at": "2022-02-23T10:12:31-03:00",
    "in_company_since": null,
    "is_certified": false,
    "language": "pt-BR",
    "alt_id": "27854252e09b8db72a8b1da31a447c21",
    "oid": "49537adb9",
    "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",
        "work_time": 0
      },
      {
        "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",
        "work_time": 28800
      },
      {
        "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",
        "work_time": 28800
      },
      {
        "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",
        "work_time": 28800
      },
      {
        "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",
        "work_time": 28800
      },
      {
        "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",
        "work_time": 28800
      },
      {
        "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",
        "work_time": 0
      }
    ],
    "is_mensurable": true,
    "time_tracking_mode": "smart",
    "blocked_by_time_worked_at": null,
    "demanders_count": 0,
    "partners_count": 0,
    "has_all_users_as_partners": false,
    "has_all_users_as_demanders": false,
    "password_updated_at": null,
    "password_expired_at": null,
    "shift_work_time_per_week": 144000,
    "team_ids": [

    ],
    "led_team_ids": [

    ],
    "skip_time_adjust_on_task_assignment_deliver": false,
    "theme": "light",
    "task_list_background_image_url": null
  }
]
GET

/api/v1.0/users/:user_id

Get a user by 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-989

Headers

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

cURL

curl "https://runrun.it/api/v1.0/users/coyote-989" -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
cost_hour Current user cost per hour decimal
is_master User is an administrator boolean
is_manager User is a manager boolean
is_auditor User is an auditor boolean
can_create_client_project_and_task_types User has permission to create client, projects and task types boolean
can_create_boards User has permission to create boards boolean
is_blocked_on_mobile User has mobile apps access blocked boolean
bypass_block_by_time_worked User ignore the blocking rule for time worked 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
created_at User creation date datetime
in_company_since Joining date in company date
is_certified Whether the user has passed Runrun.it certification boolean
language User preference language string
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
blocked_by_time_worked_at When the user is blocked for being out of the acceptable worked time defined by the company datetime
demanders_count Demanders count integer
partners_count Partners count integer
has_all_users_as_partners True if user has all users as partners boolean
has_all_users_as_demanders True if has all users as demanders boolean
password_updated_at Last time user password was updated datetime
password_expired_at Time when the user password was considered expired datetime
shift_work_time_per_week Shift work time (in seconds) per week integer
team_ids Ids from teams that the user belongs to array
led_team_ids Ids from teams the user leads array
skip_time_adjust_on_task_assignment_deliver User preference of skip adjust time modal on task deliver boolean
theme User preference of theme for interface between light or dark mode string
task_list_background_image_url Image url for background of task list string

Status

200

Headers

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

Body

{
  "id": "coyote-989",
  "name": "Coyote 989",
  "email": "coyote975@acme.foo",
  "avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-805/coyote-989/mini.png",
  "avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-805/coyote-989/regular.png",
  "cost_hour": 0.0,
  "is_master": false,
  "is_manager": false,
  "is_auditor": false,
  "can_create_client_project_and_task_types": false,
  "can_create_boards": true,
  "is_blocked_on_mobile": false,
  "bypass_block_by_time_worked": false,
  "time_zone": "America/Sao_Paulo",
  "position": null,
  "on_vacation": false,
  "birthday": null,
  "phone": null,
  "gender": null,
  "marital_status": null,
  "created_at": "2022-02-23T10:12:33-03:00",
  "in_company_since": null,
  "is_certified": false,
  "language": "pt-BR",
  "alt_id": "c16f5afc01544c12abae578ef4235a30",
  "oid": "92a6f5b72",
  "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",
      "work_time": 0
    },
    {
      "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",
      "work_time": 28800
    },
    {
      "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",
      "work_time": 28800
    },
    {
      "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",
      "work_time": 28800
    },
    {
      "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",
      "work_time": 28800
    },
    {
      "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",
      "work_time": 28800
    },
    {
      "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",
      "work_time": 0
    }
  ],
  "is_mensurable": true,
  "time_tracking_mode": "smart",
  "blocked_by_time_worked_at": null,
  "demanders_count": 0,
  "partners_count": 0,
  "has_all_users_as_partners": false,
  "has_all_users_as_demanders": false,
  "password_updated_at": null,
  "password_expired_at": null,
  "shift_work_time_per_week": 144000,
  "team_ids": [

  ],
  "led_team_ids": [

  ],
  "skip_time_adjust_on_task_assignment_deliver": false,
  "theme": "light",
  "task_list_background_image_url": null
}
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",
    "source": "my_source_value"
  }
}

cURL

curl "https://runrun.it/api/v1.0/users" -d '{"user":{"name":"Jon Smith","email":"john@smith.com","source":"my_source_value"}}' -X POST \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

201

Headers

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

Body

{
  "id": "jon-smith",
  "name": "Jon Smith",
  "email": "john@smith.com",
  "avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-806/jon-smith/0290b6051cb950186953b2ca41c221cfmini.png",
  "avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-806/jon-smith/0290b6051cb950186953b2ca41c221cfregular.png",
  "cost_hour": 0.0,
  "is_master": false,
  "is_manager": false,
  "is_auditor": false,
  "can_create_client_project_and_task_types": false,
  "can_create_boards": true,
  "is_blocked_on_mobile": false,
  "bypass_block_by_time_worked": false,
  "time_zone": "America/Sao_Paulo",
  "position": null,
  "on_vacation": false,
  "birthday": null,
  "phone": null,
  "gender": null,
  "marital_status": null,
  "created_at": "2022-02-23T10:12:35-03:00",
  "in_company_since": null,
  "is_certified": false,
  "language": "pt-BR",
  "alt_id": "d385ef394c76742fd8f1b78f38280443",
  "oid": "92a6f5b72",
  "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",
      "work_time": 0
    },
    {
      "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",
      "work_time": 27000
    },
    {
      "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",
      "work_time": 27000
    },
    {
      "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",
      "work_time": 27000
    },
    {
      "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",
      "work_time": 27000
    },
    {
      "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",
      "work_time": 27000
    },
    {
      "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",
      "work_time": 0
    }
  ],
  "is_mensurable": true,
  "time_tracking_mode": "smart",
  "blocked_by_time_worked_at": null,
  "demanders_count": 2,
  "partners_count": 2,
  "has_all_users_as_partners": true,
  "has_all_users_as_demanders": true,
  "password_updated_at": null,
  "password_expired_at": null,
  "shift_work_time_per_week": 135000,
  "team_ids": [

  ],
  "led_team_ids": [

  ],
  "skip_time_adjust_on_task_assignment_deliver": false,
  "theme": "light",
  "task_list_background_image_url": null
}
PUT

/api/v1.0/users/:id

Update a user

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",
    "time_zone": "Asia/Brunei"
  }
}

cURL

curl "https://runrun.it/api/v1.0/users/jon-smith" -d '{"user":{"name":"Steve Jobs","time_zone":"Asia/Brunei"}}' -X PUT \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "jon-smith",
  "name": "Steve Jobs",
  "email": "coyote990@acme.foo",
  "avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-815/jon-smith/mini.png",
  "avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-815/jon-smith/regular.png",
  "cost_hour": 0.0,
  "is_master": true,
  "is_manager": false,
  "is_auditor": false,
  "can_create_client_project_and_task_types": true,
  "can_create_boards": true,
  "is_blocked_on_mobile": false,
  "bypass_block_by_time_worked": false,
  "time_zone": "Asia/Brunei",
  "position": null,
  "on_vacation": false,
  "birthday": null,
  "phone": null,
  "gender": null,
  "marital_status": null,
  "created_at": "2018-01-01T00:00:00-02:00",
  "in_company_since": null,
  "is_certified": false,
  "language": "pt-BR",
  "alt_id": "84e1eb0b656d2b68a2967ecee0e85323",
  "oid": "92a6f5b72",
  "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",
      "work_time": 0
    },
    {
      "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",
      "work_time": 28800
    },
    {
      "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",
      "work_time": 28800
    },
    {
      "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",
      "work_time": 28800
    },
    {
      "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",
      "work_time": 28800
    },
    {
      "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",
      "work_time": 28800
    },
    {
      "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",
      "work_time": 0
    }
  ],
  "is_mensurable": true,
  "time_tracking_mode": "smart",
  "blocked_by_time_worked_at": null,
  "demanders_count": 0,
  "partners_count": 0,
  "has_all_users_as_partners": false,
  "has_all_users_as_demanders": false,
  "password_updated_at": null,
  "password_expired_at": null,
  "shift_work_time_per_week": 144000,
  "team_ids": [

  ],
  "led_team_ids": [

  ],
  "skip_time_adjust_on_task_assignment_deliver": false,
  "theme": "light",
  "task_list_background_image_url": null
}

UsersVacations

GET

/api/v1.0/users_vacations

Get user vacations

Request

Route

GET /api/v1.0/users_vacations

Headers

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

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

[
  {
    "id": 1,
    "user_id": "coyote-1021",
    "period_start": "2021-10-05",
    "period_end": "2021-11-20"
  }
]
POST

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

Create an user vacation

Request

Route

POST /api/v1.0/users/coyote-1023/vacations

Headers

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

Body

{
  "user_vacation": {
    "period_start": "2021-11-01",
    "period_end": "2021-12-01"
  }
}

cURL

curl "https://runrun.it/api/v1.0/users/coyote-1023/vacations" -d '{"user_vacation":{"period_start":"2021-11-01","period_end":"2021-12-01"}}' -X POST \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

201

Headers

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

Body

{
  "id": 1,
  "user_id": "coyote-1023",
  "period_start": "2021-11-01",
  "period_end": "2021-12-01"
}
GET

/api/v1.0/users_vacations/:id

Show an user vacation

Request

Route

GET /api/v1.0/users_vacations/1

Headers

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

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": 1,
  "user_id": "coyote-1025",
  "period_start": "2021-10-05",
  "period_end": "2021-11-20"
}
PUT

/api/v1.0/users_vacations/:id

Update an user vacation

Request

Route

PUT /api/v1.0/users_vacations/:id

Headers

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

cURL

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

Response

Simulated Response

Status

404

Headers

Content-Type: text/html
Content-Length: 0

Request

Route

PUT /api/v1.0/users_vacations/1

Headers

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

Body

{
  "user_vacation": {
    "period_start": "2021-11-01",
    "period_end": "2021-12-01"
  }
}

cURL

curl "https://runrun.it/api/v1.0/users_vacations/1" -d '{"user_vacation":{"period_start":"2021-11-01","period_end":"2021-12-01"}}' -X PUT \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": 1,
  "user_id": "coyote-1027",
  "period_start": "2021-11-01",
  "period_end": "2021-12-01"
}
DELETE

/api/v1.0/users_vacations/:id

Destroy an user vacation

Request

Route

DELETE /api/v1.0/users_vacations/1

Headers

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

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": 1,
  "user_id": "coyote-1029",
  "period_start": "2021-10-05",
  "period_end": "2021-11-20"
}

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=1

Headers

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

Query Parameters

task_id=1

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

[
  {
    "id": 1,
    "task_id": 1,
    "start": "2014-01-08T15:00:00-02:00",
    "end": null,
    "user_id": "coyote-629",
    "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=1

Headers

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

Query Parameters

task_id=1

cURL

curl "https://runrun.it/api/v1.0/work_periods/1?task_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 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

200

Headers

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

Body

{
  "id": 1,
  "task_id": 1,
  "start": "2014-01-08T15:00:00-02:00",
  "end": "2014-01-08T16:00:00-02:00",
  "user_id": "coyote-631",
  "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://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

200

Headers

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

Body

[
  {
    "id": 1,
    "workflow_id": 1,
    "order": 1,
    "is_current": true,
    "is_completed": false,
    "current": true,
    "completed": false,
    "completed_at": null,
    "started_at": "2018-11-16T15:42:53-02:00",
    "team_id": null,
    "user_id": "coyote-633"
  },
  {
    "id": 2,
    "workflow_id": 1,
    "order": 1,
    "is_current": false,
    "is_completed": false,
    "current": false,
    "completed": false,
    "completed_at": null,
    "started_at": null,
    "team_id": 1,
    "user_id": "coyote-634"
  }
]
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://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

200

Headers

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

Body

{
  "id": 2,
  "workflow_id": 1,
  "order": 2,
  "is_current": false,
  "is_completed": false,
  "current": false,
  "completed": false,
  "completed_at": null,
  "started_at": null,
  "team_id": 1,
  "user_id": "coyote-638"
}
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-642",
    "team_id": 1,
    "order": 2
  }
}

cURL

curl "https://runrun.it/api/v1.0/workflows/1/workflow_elements" -d '{"workflow_element":{"user_id":"coyote-642","team_id":1,"order":2}}' -X POST \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

201

Headers

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

Body

{
  "id": 2,
  "workflow_id": 1,
  "order": 2,
  "is_current": false,
  "is_completed": false,
  "current": false,
  "completed": false,
  "completed_at": null,
  "started_at": null,
  "team_id": 1,
  "user_id": "coyote-642"
}
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://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

200

Headers

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

Body

{
  "id": 3,
  "workflow_id": 1,
  "order": 2,
  "is_current": false,
  "is_completed": false,
  "current": false,
  "completed": false,
  "completed_at": null,
  "started_at": null,
  "team_id": 1,
  "user_id": "coyote-649"
}
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://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

204

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=1

Headers

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

Query Parameters

task_id=1

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": 1,
  "workable_id": 1,
  "workable_type": "Task",
  "task_id": 1,
  "current_workflow_element_id": 1,
  "is_last_element": true,
  "is_first_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": 1,
  "workflow": {
  }
}

cURL

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

Response

Simulated Response

Status

201

Headers

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

Body

{
  "id": 1,
  "workable_id": 1,
  "workable_type": "Task",
  "task_id": 1,
  "current_workflow_element_id": 1,
  "is_last_element": true,
  "is_first_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": 1
}

cURL

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

Response

Simulated Response

Status

204

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://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

200

Headers

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

Body

{
  "id": 1,
  "workable_id": 33,
  "workable_type": "TaskTemplate",
  "task_template_id": 33,
  "current_workflow_element_id": null,
  "is_last_element": true,
  "is_first_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://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

201

Headers

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

Body

{
  "id": 1,
  "workable_id": 34,
  "workable_type": "TaskTemplate",
  "task_template_id": 34,
  "current_workflow_element_id": null,
  "is_last_element": true,
  "is_first_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://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

Status

204

Headers