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.

Go to Integration and Apps on Runrun.it
Then look for "API and Webhooks" and click Open
Your app_key will be displayed next to the 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

Initial Request: Start with your API call without specific page, limit, or offset.
Analyzing the Response: Check the X-Item-Range and Link headers. The Link header includes navigation links such as self, prev, next, and last.
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.
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:update → Triggered when the following task attributes are updated: title, tags, desired delivery date, desired start date, points, custom fields.
task:destroy → Triggered when a task is deleted.
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:mark_as_urgent → Triggered when a task is marked as urgent.
task:unmark_as_urgent → Triggered when a task is unmarked as urgent.
task:desired_start_date_upcoming → Triggered when task desired start date is upcoming.
task_assignment:play → Triggered when an assignee clicks on the play button.
task_assignment:pause → Triggered when an assignee clicks on the pause button.
task:change_evaluation_status → Triggered when the task evaluation status changes.
task:evaluations:create → Triggered when new evaluation requests are created.
task:evaluations:reset → Triggered when existing evaluation requests are requested again.
task:evaluations:destroy → Triggered when existing evaluation requests are deleted.
task:evaluation:approve → Triggered when an evaluation request is approved.
task:evaluation:reject → Triggered when an evaluation request is rejected.
task:evaluation:reset → Triggered when an evaluation request is reseted.
task:assignments:create → Triggered when new assignees are added to a task.
task:description:update → Triggered when task description is updated.
task:comment:create → Triggered when a comment on a task is created by a user.
task:comment:update → Triggered when a comment on a task is edited by a user.
project:create → Triggered when a project is created.
project:change_time_worked → Triggered when the total time worked on a project changes.
project:comment:create → Triggered when a comment on a project is created by a user.
project:comment:update → Triggered when a comment on a project is edited by a user.
client:create → Triggered when a client is created.
team:comment:create → Triggered when a comment on a team bulletin is created by a user.
team:comment:update → Triggered when a comment on a team bulletin is edited by a user.
enterprise:comment:create → Triggered when a comment on the enterprise bulletin is created by a user.
enterprise:comment:update → Triggered when a comment on the enterprise bulletin is edited by a user.
document:comment:create → Triggered when a comment on an attachment is created by a user.
document:comment:update → Triggered when a comment on an attachment is edited by a user.

Response

Here are some examples of the HTTP POST payload:

task:create

    {
      "event": "task:create",
      "happened_at": "2024-10-08 11:15:32 -0300",
      "performer": { "id": "john-snow", "email": "john.snow@runrun.it" },
      "data": {
        "task": {
          "id": 1696,
          "title": "task 1",
          "board": { "id": 25 },
          "board_stage": { "id": 254 },
          "project": nil,
          "time_worked": 0,
          "evaluation_status": nil,
          "assignees": [],
          "assignments": [],
          "user": { "id": "john-snow", "email": "john.snow@runrun.it" },
          "points": nil,
          "tags_data": [],
          "desired_start_date": nil,
          "desired_date": nil,
          "is_urgent": false,
          "custom_fields": {},
          "url": "http://localhost:3000/pt-BR/tasks/1696"
        }
      }
    }

task:update

  {
    "event": "task:update",
    "happened_at": "2024-10-08 11:21:34 -0300",
    "performer": { "id": "john-snow", "email": "john.snow@runrun.it" },
    "data": {
      "task": {
        "id": 1696,
        "title": "task 1",
        "board": { "id": 25 },
        "board_stage": { "id": 254 },
        "project": nil,
        "time_worked": 0,
        "evaluation_status": nil,
        "assignees": [],
        "assignments": [],
        "user": { "id": "john-snow", "email": "john.snow@runrun.it" },
        "points": nil,
        "tags_data": [],
        "desired_start_date": nil,
        "desired_date": nil,
        "is_urgent": false,
        "custom_fields": {},
        "url": "http://localhost:3000/pt-BR/tasks/1696"
      }
    }
  }

task:destroy

    {
      "event": "task:destroy",
      "happened_at": "2024-10-08 11:25:24 -0300",
      "performer": { "id": "john-snow", "email": "john.snow@runrun.it" },
      "data": {
        "task": {
          "id": 1696,
          "title": "task 1",
          "board": { "id": 25 },
          "board_stage": { "id": 254 },
          "project": nil,
          "time_worked": 0,
          "evaluation_status": nil,
          "assignees": [],
          "assignments": [],
          "user": { "id": "john-snow", "email": "john.snow@runrun.it" },
          "points": nil,
          "tags_data": [],
          "desired_start_date": nil,
          "desired_date": nil,
          "is_urgent": false,
          "custom_fields": {},
          "url": "http://localhost:3000/pt-BR/tasks/1696"
        }
      }
    }

task:deliver

    {
      "event": "task:deliver",
      "happened_at": "2024-10-08 11:28:46 -0300",
      "performer": { "id": "john-snow", "email": "john.snow@runrun.it" },
      "data": {
        "task": {
          "id": 1696,
          "title": "task 1",
          "board": { "id": 25 },
          "board_stage": { "id": 254 },
          "project": nil,
          "time_worked": 246303,
          "evaluation_status": nil,
          "assignees": [
            { "id": "petey-cruiser", "email": "petey.cruiser@runrun.it" }
          ],
          "assignments": [
            {
              "assignee": { "id": "petey-cruiser", "email": "petey.cruiser@runrun.it" }
            }
          ],
          "user": { "id": "anna-mull", "email": "anna.mull@runrun.it" },
          "points": nil,
          "tags_data": [],
          "desired_start_date": nil,
          "desired_date": nil,
          "is_urgent": false,
          "custom_fields": {},
          "url": "http://localhost:3000/pt-BR/tasks/1696"
        }
      }
    }

task:reopen

    {
      "event": "task:reopen",
      "happened_at": "2024-10-08 13:52:52 -0300",
      "performer": { "id": "john-snow", "email": "john.snow@runrun.it" },
      "data": {
        "task": {
          "id": 1696,
          "title": "task 1",
          "board": { "id": 25 },
          "board_stage": { "id": 254 },
          "project": nil,
          "time_worked": 246303,
          "evaluation_status": nil,
          "assignees": [
            { "id": "petey-cruiser", "email": "petey.cruiser@runrun.it" }
          ],
          "assignments": [
            {
              "assignee": { "id": "petey-cruiser", "email": "petey.cruiser@runrun.it" }
            }
          ],
          "user": { "id": "anna-mull", "email": "anna.mull@runrun.it" },
          "points": nil,
          "tags_data": [],
          "desired_start_date": nil,
          "desired_date": nil,
          "is_urgent": false,
          "custom_fields": {},
          "url": "http://localhost:3000/pt-BR/tasks/1696"
        }
      }
    }

task:move

    {
      "event": "task:move",
      "happened_at": "2024-10-08 14:06:40 -0300",
      "performer": { "id": "john-snow", "email": "john.snow@runrun.it" },
      "data": {
        "task": {
          "id": 1696,
          "title": "task 1",
          "board": { "id": 25 },
          "board_stage": { "id": 254 },
          "project": nil,
          "time_worked": 246303,
          "evaluation_status": nil,
          "assignees": [
            { "id": "petey-cruiser", "email": "petey.cruiser@runrun.it" }
          ],
          "assignments": [
            { 
              "assignee": { "id": "petey-cruiser", "email": "petey.cruiser@runrun.it" }
            }
          ],
          "user": { "id": "anna-mull", "email": "anna.mull@runrun.it" },
          "points": nil,
          "tags_data": [],
          "desired_start_date": nil,
          "desired_date": nil,
          "is_urgent": false,
          "custom_fields": {},
          "url": "http://localhost:3000/pt-BR/tasks/1696"
        }
      }
    }

task:add_manual_work_period

    {
      "event": "task:add_manual_work_period",
      "happened_at": "2024-10-08 14:09:20 -0300",
      "performer": { "id": "john-snow", "email": "john.snow@runrun.it" },
      "data": {
        "task": {
          "id": 1696,
          "title": "task 1",
          "board": { "id": 25 },
          "board_stage": { "id": 254 },
          "project": nil,
          "time_worked": 249903,
          "evaluation_status": nil,
          "assignees": [
            { "id": "petey-cruiser", "email": "petey.cruiser@runrun.it" }
          ],
          "assignments": [
            {
              "assignee": { "id": "petey-cruiser", "email": "petey.cruiser@runrun.it" }
            }
          ],
          "user": { "id": "anna-mull", "email": "anna.mull@runrun.it" },
          "points": nil,
          "tags_data": [],
          "desired_start_date": nil,
          "desired_date": nil,
          "is_urgent": false,
          "custom_fields": {},
          "url": "http://localhost:3000/pt-BR/tasks/1696"
        }
      }
    }

task:remove_manual_work_period

    {
      "event": "task:remove_manual_work_period",
      "happened_at": "2024-10-08 14:10:43 -0300",
      "performer": { "id": "john-snow", "email": "john.snow@runrun.it" },
      "data": {
        "task": {
          "id": 1696,
          "title": "task 1",
          "board": { "id": 25 },
          "board_stage": { "id": 254 },
          "project": nil,
          "time_worked": 246303,
          "evaluation_status": nil,
          "assignees": [
            { "id": "petey-cruiser", "email": "petey.cruiser@runrun.it" }
          ],
          "assignments": [
            {
              "assignee": { "id": "petey-cruiser", "email": "petey.cruiser@runrun.it" }
            }
          ],
          "user": { "id": "anna-mull", "email": "anna.mull@runrun.it" },
          "points": nil,
          "tags_data": [],
          "desired_start_date": nil,
          "desired_date": nil,
          "is_urgent": false,
          "custom_fields": {},
          "url": "http://localhost:3000/pt-BR/tasks/1696"
        }
      }
    }

task:change_time_worked

    {
      "event": "task:change_time_worked",
      "happened_at": "2024-10-08 14:23:44 -0300",
      "performer": nil,
      "data": {
        "task": {
          "id": 1696,
          "title": "task 1",
          "board": { "id": 25 },
          "board_stage": { "id": 254 },
          "project": nil,
          "time_worked": 158,
          "evaluation_status": nil,
          "assignees": [
            { "id": "john-snow", "email": "john.snow@runrun.it" },
            {"id": "ned-stark", "email": "ned.stark@runrun.it"}
          ],
          "assignments": [
            {
              "assignee": { "id": "john-snow", "email": "john.snow@runrun.it" }
            },
            {
              "assignee": {"id": "ned-stark", "email": "ned.stark@runrun.it"}
            }
          ],
          "user": { "id": "anna-mull", "email": "anna.mull@runrun.it" },
          "points": nil,
          "tags_data": [],
          "desired_start_date": "2024-10-08 15:00:00 -0300",
          "desired_date": "2024-10-08 23:59:00 -0300",
          "is_urgent": false,
          "custom_fields": {},
          "url": "http://localhost:3000/pt-BR/tasks/1696"
        }
      }
    }

task:mark_as_urgent

    {
      "event": "task:mark_as_urgent",
      "happened_at": "2024-10-08 14:07:40 -0300",
      "performer": { "id": "john-snow", "email": "john.snow@runrun.it" },
      "data": {
        "task": {
          "id": 1696,
          "title": "task 1",
          "board": { "id": 25 },
          "board_stage": { "id": 254 },
          "project": nil,
          "time_worked": 246303,
          "evaluation_status": nil,
          "assignees": [
            { "id": "petey-cruiser", "email": "petey.cruiser@runrun.it" }
          ],
          "assignments": [
            {
              "assignee": { "id": "petey-cruiser", "email": "petey.cruiser@runrun.it" }
            }
          ],
          "user": { "id": "anna-mull", "email": "anna.mull@runrun.it" },
          "points": nil,
          "tags_data": [],
          "desired_start_date": nil,
          "desired_date": nil,
          "is_urgent": true,
          "custom_fields": {},
          "url": "http://localhost:3000/pt-BR/tasks/1696"
        }
      }
    }

task:unmark_as_urgent

    {
      "event": "task:unmark_as_urgent",
      "happened_at": "2024-10-08 14:08:23 -0300",
      "performer": { "id": "john-snow", "email": "john.snow@runrun.it" },
      "data": {
        "task": {
          "id": 1696,
          "title": "task 1",
          "board": { "id": 25 },
          "board_stage": { "id": 254 },
          "project": nil,
          "time_worked": 246303,
          "evaluation_status": nil,
          "assignees": [
            { "id": "petey-cruiser", "email": "petey.cruiser@runrun.it" }
          ],
          "assignments": [
            {
              "assignee": { "id": "petey-cruiser", "email": "petey.cruiser@runrun.it" }
            }
          ],
          "user": { "id": "anna-mull", "email": "anna.mull@runrun.it" },
          "points": nil,
          "tags_data": [],
          "desired_start_date": nil,
          "desired_date": nil,
          "is_urgent": false,
          "custom_fields": {},
          "url": "http://localhost:3000/pt-BR/tasks/1696"
        }
      }
    }

task:desired_start_date_upcoming

    {
      "event": "task:desired_start_date_upcoming",
      "happened_at": "2024-10-08 14:15:36 -0300",
      "performer": nil,
      "data": {
        "task": {
          "id": 1696,
          "title": "task 1",
          "board": { "id": 25 },
          "board_stage": { "id": 254 },
          "project": nil,
          "time_worked": 246303,
          "evaluation_status": nil,
          "assignees": [
            { "id": "petey-cruiser", "email": "petey.cruiser@runrun.it" }
          ],  
          "assignments": [
            {
              "assignee": { "id": "petey-cruiser", "email": "petey.cruiser@runrun.it" }
            }
          ],
          "user": { "id": "anna-mull", "email": "anna.mull@runrun.it" },
          "points": nil,
          "tags_data": [],
          "desired_start_date": "2024-10-08 15:00:00 -0300",
          "desired_date": "2024-10-08 23:59:00 -0300",
          "is_urgent": false,
          "custom_fields": {},
          "url": "http://localhost:3000/pt-BR/tasks/1696"
        }
      }
    }

task_assignment:play

    {
      "event": "task_assignment:play",
      "happened_at": "2024-10-08 14:57:35 -0300",
      "performer": { "id": "john-snow", "email": "john.snow@runrun.it" },
      "data": {
        "task": {
          "id": 1696,
          "title": "task 1",
          "board": { "id": 25 },
          "board_stage": { "id": 254 },
          "project": nil,
          "time_worked": 158,
          "evaluation_status": "pending",
          "assignees": [
            { "id": "john-snow", "email": "john.snow@runrun.it" },
            {"id": "ned-stark", "email": "ned.stark@runrun.it"}
          ],
          "assignments": [
            {
              "assignee": { "id": "john-snow", "email": "john.snow@runrun.it" }
            },
            {
              "assignee": {"id": "ned-stark", "email": "ned.stark@runrun.it"}
            }
          ],
          "user": { "id": "anna-mull", "email": "anna.mull@runrun.it" },
          "points": nil,
          "tags_data": [],
          "desired_start_date": "2024-10-08 15:00:00 -0300",
          "desired_date": "2024-10-08 23:59:00 -0300",
          "is_urgent": false,
          "custom_fields": {},
          "url": "http://localhost:3000/pt-BR/tasks/1696"
        }
      }
    }

task_assignment:pause

    {
      "event": "task_assignment:pause",
      "happened_at": "2024-10-08 14:58:12 -0300",
      "performer": { "id": "john-snow", "email": "john.snow@runrun.it" },
      "data": {
        "task": {
          "id": 1696,
          "title": "task 1",
          "board": { "id": 25 },
          "board_stage": { "id": 254 },
          "project": nil,
          "time_worked": 197,
          "evaluation_status": "pending",
          "assignees": [
            { "id": "john-snow", "email": "john.snow@runrun.it" },
            {"id": "ned-stark", "email": "ned.stark@runrun.it"}
          ],
          "assignments": [
            {
              "assignee": { "id": "john-snow", "email": "john.snow@runrun.it" }
            },
            {
              "assignee": {"id": "ned-stark", "email": "ned.stark@runrun.it"}
            }
          ],
          "user": { "id": "anna-mull", "email": "anna.mull@runrun.it" },
          "points": nil,
          "tags_data": [],
          "desired_start_date": "2024-10-08 15:00:00 -0300",
          "desired_date": "2024-10-08 23:59:00 -0300",
          "is_urgent": false,
          "custom_fields": {},
          "url": "http://localhost:3000/pt-BR/tasks/1696"
        }
      }
    }

task:change_evaluation_status

    {
      "event": "task:change_evaluation_status",
      "happened_at": "2024-10-08 14:30:52 -0300",
      "performer": nil,
      "data": {
        "task": {
          "id": 1696,
          "title": "task 1",
          "board": { "id": 25 },
          "board_stage": { "id": 254 },
          "project": nil,
          "time_worked": 158,
          "evaluation_status": "approved",
          "assignees": [
            { "id": "john-snow", "email": "john.snow@runrun.it" },
            {"id": "ned-stark", "email": "ned.stark@runrun.it"}
          ],
          "assignments": [
            {
              "assignee": { "id": "john-snow", "email": "john.snow@runrun.it" }
            },
            {
              "assignee": {"id": "ned-stark", "email": "ned.stark@runrun.it"}
            }
          ],
          "user": { "id": "anna-mull", "email": "anna.mull@runrun.it" },
          "points": nil,
          "tags_data": [],
          "desired_start_date": "2024-10-08 15:00:00 -0300",
          "desired_date": "2024-10-08 23:59:00 -0300",
          "is_urgent": false,
          "custom_fields": {},
          "url": "http://localhost:3000/pt-BR/tasks/1696"
        }
      }
    }

task:evaluations:create

    {
      "event": "task:evaluations:create",
      "happened_at": "2024-10-08 14:25:03 -0300",
      "performer": { "id": "john-snow", "email": "john.snow@runrun.it" },
      "data": {
        "task": {
          "id": 1696,
          "title": "task 1",
          "board": { "id": 25 },
          "board_stage": { "id": 254 },
          "project": nil,
          "time_worked": 158,
          "evaluation_status": "pending",
          "assignees": [
            { "id": "john-snow", "email": "john.snow@runrun.it" },
            {"id": "ned-stark", "email": "ned.stark@runrun.it"}
          ],
          "assignments": [
            {
              "assignee": { "id": "john-snow", "email": "john.snow@runrun.it" }
            },
            {
              "assignee": {"id": "ned-stark", "email": "ned.stark@runrun.it"}
            }
          ],
          "user": { "id": "anna-mull", "email": "anna.mull@runrun.it" },
          "points": nil,
          "tags_data": [],
          "desired_start_date": "2024-10-08 15:00:00 -0300",
          "desired_date": "2024-10-08 23:59:00 -0300",
          "is_urgent": false,
          "custom_fields": {},
          "url": "http://localhost:3000/pt-BR/tasks/1696"
        },
        "evaluations": [
          {
            "state": "pending",
            "evaluator": {"id": "antonio-carlos-soares", "email": "acsoares@runrun.it"}
          }
        ]
      }
    }

task:evaluations:reset

    {
      "event": "task:evaluations:reset",
      "happened_at": "2024-10-08 14:29:21 -0300",
      "performer": { "id": "john-snow", "email": "john.snow@runrun.it" },
      "data": {
        "task": {
          "id": 1696,
          "title": "task 1",
          "board": { "id": 25 },
          "board_stage": { "id": 254 },
          "project": nil,
          "time_worked": 158,
          "evaluation_status": "pending",
          "assignees": [
            { "id": "john-snow", "email": "john.snow@runrun.it" 
            },
            {"id": "ned-stark", "email": "ned.stark@runrun.it"}],
          "assignments": 
            [{"assignee": 
              { "id": "john-snow", "email": "john.snow@runrun.it" }},
            {"assignee": 
              {"id": "ned-stark", "email": "ned.stark@runrun.it"}}],
          "user": { "id": "anna-mull", "email": "anna.mull@runrun.it" },
          "points": nil,
          "tags_data": [],
          "desired_start_date": "2024-10-08 15:00:00 -0300",
          "desired_date": "2024-10-08 23:59:00 -0300",
          "is_urgent": false,
          "custom_fields": {},
          "url": "http://localhost:3000/pt-BR/tasks/1696"},
        "evaluations": 
          [{"state": "pending",
            "evaluator": 
            { "id": "john-snow", "email": "john.snow@runrun.it" }}]}}

task:evaluations:destroy

    {
      "event": "task:evaluations:destroy",
      "happened_at": "2024-10-08 14:26:45 -0300",
      "performer": { "id": "john-snow", "email": "john.snow@runrun.it" },
      "data": {
        "task": {
          "id": 1696,
          "title": "task 1",
          "board": { "id": 25 },
          "board_stage": { "id": 254 },
          "project": nil,
          "time_worked": 158,
          "evaluation_status": nil,
          "assignees": [
            { "id": "john-snow", "email": "john.snow@runrun.it" },
            {"id": "ned-stark", "email": "ned.stark@runrun.it"}
          ],
          "assignments": [
            {"assignee": { "id": "john-snow", "email": "john.snow@runrun.it" }},
            {"assignee": {"id": "ned-stark", "email": "ned.stark@runrun.it"}}
          ],
          "user": { "id": "anna-mull", "email": "anna.mull@runrun.it" },
          "points": nil,
          "tags_data": [],
          "desired_start_date": "2024-10-08 15:00:00 -0300",
          "desired_date": "2024-10-08 23:59:00 -0300",
          "is_urgent": false,
          "custom_fields": {},
          "url": "http://localhost:3000/pt-BR/tasks/1696"},
        "evaluations": [
          {
            "state": "pending",
            "evaluator": {"id": "antonio-carlos-soares", "email": "acsoares@runrun.it"}
          }
        ]
      }
    }

task:evaluation:approve

    {
      "event": "task:evaluation:approve",
      "happened_at": "2024-10-08 14:28:01 -0300",
      "performer": { "id": "john-snow", "email": "john.snow@runrun.it" },
      "data": {
        "evaluation": {
          "state": "approved",
          "evaluator": { "id": "john-snow", "email": "john.snow@runrun.it" }
        },
        "task": {
          "id": 1696,
          "title": "task 1",
          "board": { "id": 25 },
          "board_stage": { "id": 254 },
          "project": nil,
          "time_worked": 158,
          "evaluation_status": "approved",
          "assignees": [
            { "id": "john-snow", "email": "john.snow@runrun.it" },
            {"id": "ned-stark", "email": "ned.stark@runrun.it"}
          ],
          "assignments": [
            {"assignee": { "id": "john-snow", "email": "john.snow@runrun.it" }},
            {"assignee": {"id": "ned-stark", "email": "ned.stark@runrun.it"}}
          ],
          "user": { "id": "anna-mull", "email": "anna.mull@runrun.it" },
          "points": nil,
          "tags_data": [],
          "desired_start_date": "2024-10-08 15:00:00 -0300",
          "desired_date": "2024-10-08 23:59:00 -0300",
          "is_urgent": false,
          "custom_fields": {},
          "url": "http://localhost:3000/pt-BR/tasks/1696"
        }
      }
    }

task:evaluation:reject

    {
      "event": "task:evaluation:reject",
      "happened_at": "2024-10-08 14:43:03 -0300",
      "performer": { "id": "john-snow", "email": "john.snow@runrun.it" },
      "data": {
        "evaluation": {
          "state": "rejected",
          "evaluator": { "id": "john-snow", "email": "john.snow@runrun.it" }
        },
        "task": {
          "id": 1696,
          "title": "task 1",
          "board": { "id": 25 },
          "board_stage": { "id": 254 },
          "project": nil,
          "time_worked": 158,
          "evaluation_status": "rejected",
          "assignees": [
            { "id": "john-snow", "email": "john.snow@runrun.it" },
            {"id": "ned-stark", "email": "ned.stark@runrun.it"}
          ],
          "assignments": [
            {"assignee": { "id": "john-snow", "email": "john.snow@runrun.it" }},
            {"assignee": {"id": "ned-stark", "email": "ned.stark@runrun.it"}}
          ],
          "user": { "id": "anna-mull", "email": "anna.mull@runrun.it" },
          "points": nil,
          "tags_data": [],
          "desired_start_date": "2024-10-08 15:00:00 -0300",
          "desired_date": "2024-10-08 23:59:00 -0300",
          "is_urgent": false,
          "custom_fields": {},
          "url": "http://localhost:3000/pt-BR/tasks/1696"
        }
      }
    }

task:evaluation:reset

    {
      "event": "task:evaluation:reset",
      "happened_at": "2024-10-08 14:55:47 -0300",
      "performer": { "id": "john-snow", "email": "john.snow@runrun.it" },
      "data": {
        "evaluation": {
          "state": "pending",
          "evaluator": { "id": "john-snow", "email": "john.snow@runrun.it" }
        },
        "task": {
          "id": 1696,
          "title": "task 1",
          "board": { "id": 25 },
          "board_stage": { "id": 254 },
          "project": nil,
          "time_worked": 158,
          "evaluation_status": "pending",
          "assignees": [
            { "id": "john-snow", "email": "john.snow@runrun.it" },
            {"id": "ned-stark", "email": "ned.stark@runrun.it"}
          ],
          "assignments": [
            {"assignee": { "id": "john-snow", "email": "john.snow@runrun.it" }},
            {"assignee": {"id": "ned-stark", "email": "ned.stark@runrun.it"}}
          ],
          "user": { "id": "anna-mull", "email": "anna.mull@runrun.it" },
          "points": nil,
          "tags_data": [],
          "desired_start_date": "2024-10-08 15:00:00 -0300",
          "desired_date": "2024-10-08 23:59:00 -0300",
          "is_urgent": false,
          "custom_fields": {},
          "url": "http://localhost:3000/pt-BR/tasks/1696"
        }
      }
    }

task:assignments:create

    {
      "event": "task:assignments:create",
      "happened_at": "2024-10-08 14:45:54 -0300",
      "performer": { "id": "john-snow", "email": "john.snow@runrun.it" },
      "data": {
        "task": {
          "id": 1696,
          "title": "task 1",
          "board": { "id": 25 },
          "board_stage": { "id": 254 },
          "project": nil,
          "time_worked": 158,
          "evaluation_status": "pending",
          "assignees": [
            { "id": "john-snow", "email": "john.snow@runrun.it" },
            {"id": "ned-stark", "email": "ned.stark@runrun.it"}
          ],
          "assignments": [
            {"assignee": { "id": "john-snow", "email": "john.snow@runrun.it" }},
            {"assignee": {"id": "ned-stark", "email": "ned.stark@runrun.it"}}
          ],
          "user": { "id": "anna-mull", "email": "anna.mull@runrun.it" },
          "points": nil,
          "tags_data": [],
          "desired_start_date": "2024-10-08 15:00:00 -0300",
          "desired_date": "2024-10-08 23:59:00 -0300",
          "is_urgent": false,
          "custom_fields": {},
          "url": "http://localhost:3000/pt-BR/tasks/1696"},
        "assignments": [
          {"assignee": {"id": "ned-stark", "email": "ned.stark@runrun.it"}}
        ]
      }
    }

task:description:update

    {
      "event": "task:description:update",
      "happened_at": "2024-10-08 14:49:06 -0300",
      "performer": { "id": "john-snow", "email": "john.snow@runrun.it" },
      "data": {
        "task": {
          "id": 1696,
          "title": "task 1",
          "board": { "id": 25 },
          "board_stage": { "id": 254 },
          "project": nil,
          "time_worked": 158,
          "evaluation_status": "pending",
          "assignees": [
            { "id": "john-snow", "email": "john.snow@runrun.it" },
            {"id": "ned-stark", "email": "ned.stark@runrun.it"}
          ],
          "assignments": [
            {"assignee": { "id": "john-snow", "email": "john.snow@runrun.it" }},
            {"assignee": {"id": "ned-stark", "email": "ned.stark@runrun.it"}}
          ],
          "user": { "id": "anna-mull", "email": "anna.mull@runrun.it" },
          "points": nil,
          "tags_data": [],
          "desired_start_date": "2024-10-08 15:00:00 -0300",
          "desired_date": "2024-10-08 23:59:00 -0300",
          "is_urgent": false,
          "custom_fields": {},
          "url": "http://localhost:3000/pt-BR/tasks/1696"},
        "description": {"description": "<p>description</p>"}
      }
    }

task:comment:create

    {
      "event": "task:comment:create",
      "happened_at": "2024-10-08 14:50:39 -0300",
      "performer": { "id": "john-snow", "email": "john.snow@runrun.it" },
      "data": {
        "comment": {
          "id": 569252855,
          "commentable_type": "Task",
          "commentable": {
            "id": 1696,
            "title": "task 1",
            "board": { "id": 25 },
            "board_stage": { "id": 254 },
            "project": nil,
            "time_worked": 158,
            "evaluation_status": "pending",
            "assignees": [
              { "id": "john-snow", "email": "john.snow@runrun.it" },
              {"id": "ned-stark", "email": "ned.stark@runrun.it"}
            ],
            "assignments": [
              {"assignee": { "id": "john-snow", "email": "john.snow@runrun.it" }},
              {"assignee": {"id": "ned-stark","email": "ned.stark@runrun.it"}}
            ],
            "user": { "id": "anna-mull", "email": "anna.mull@runrun.it" },
            "points": nil,
            "tags_data": [],
            "desired_start_date": "2024-10-08 15:00:00 -0300",
            "desired_date": "2024-10-08 23:59:00 -0300",
            "is_urgent": false,
            "custom_fields": {},
            "url": "http://localhost:3000/pt-BR/tasks/1696"
          },
          "text": "new comment",
          "channel_name": nil,
          "created_at": "2024-10-08 14:50:34 -0300",
          "edited_at": nil,
          "user": { "id": "john-snow", "email": "john.snow@runrun.it" },
          "guest": nil,
          "mentions": {
            "users": [],
            "tasks": []
          }
        }
      }
    }

task:comment:update

    {
      "event": "task:comment:update",
      "happened_at": "2024-10-08 14:51:38 -0300",
      "performer": { "id": "john-snow", "email": "john.snow@runrun.it" },
      "data": {
        "comment": {
          "id": 569252855,
          "commentable_type": "Task",
          "commentable": {
            "id": 1696,
            "title": "task 1",
            "board": { "id": 25 },
            "board_stage": { "id": 254 },
            "project": nil,
            "time_worked": 158,
            "evaluation_status": "pending",
            "assignees": [
              { "id": "john-snow", "email": "john.snow@runrun.it" },
              {"id": "ned-stark", "email": "ned.stark@runrun.it"}
            ],
            "assignments": [
              {"assignee": { "id": "john-snow", "email": "john.snow@runrun.it" }},
              {"assignee": {"id": "ned-stark", "email": "ned.stark@runrun.it"}}
            ],
            "user": { "id": "anna-mull", "email": "anna.mull@runrun.it" },
            "points": nil,
            "tags_data": [],
            "desired_start_date": "2024-10-08 15:00:00 -0300",
            "desired_date": "2024-10-08 23:59:00 -0300",
            "is_urgent": false,
            "custom_fields": {},
            "url": "http://localhost:3000/pt-BR/tasks/1696"
          },
          "text": "new comment edited",
          "channel_name": nil,
          "created_at": "2024-10-08 14:50:34 -0300",
          "edited_at": "2024-10-08 14:51:34 -0300",
          "user": { "id": "john-snow", "email": "john.snow@runrun.it" },
          "guest": nil,
          "mentions": {
            "users": [],
            "tasks": []
          }
        }
      }
    }

project:create

    {
      "event": "project:create",
      "happened_at": "2024-10-09 08:51:58 -0300",
      "performer": { "id": "john-snow", "email": "john.snow@runrun.it" },
      "data": {
        "project": {
          "id": 985,
          "project_sub_group": { "id": 3846 },
          "project_group": { "id": 6528 },
          "time_worked": 0,
          "client": { "id": 5849 },
          "url": "http://localhost:3000/pt-BR/company/projects/985"
        }
      }
    }

project:change_time_worked

    {
      "event": "project:change_time_worked",
      "happened_at": "2024-10-09 08:56:03 -0300",
      "performer": { "id": "john-snow", "email": "john.snow@runrun.it" },
      "data": {
        "project": {
          "id": 985,
          "project_sub_group": { "id": 3846 },
          "project_group": { "id": 6528 },
          "time_worked": 0,
          "client": { "id": 5849 },
          "url": "http://localhost:3000/pt-BR/company/projects/985"
        }
      }
    }

project:comment:create

    {
      "event": "project:comment:create",
      "happened_at": "2024-10-09 08:53:04 -0300",
      "performer": { "id": "john-snow", "email": "john.snow@runrun.it" },
      "data": {
        "comment": {
          "id": 8548,
          "commentable_type": "Project",
          "commentable": {
            "id": 985,
            "project_sub_group": { "id": 3846 },
            "project_group": { "id": 6528 },
            "time_worked": 0,
            "client": { "id": 5849 },
            "url": "http://localhost:3000/pt-BR/company/projects/985"
          },
          "text": "New comment",
          "channel_name": nil,
          "created_at": "2024-10-09 08:53:04 -0300",
          "edited_at": nil,
          "user": { "id": "john-snow", "email": "john.snow@runrun.it" },
          "guest": nil,
          "mentions": {
            "users": [],
            "tasks": []
          }
        }
      }
    }

project:comment:update

    {
      "event": "project:comment:update",
      "happened_at": "2024-10-09 08:53:54 -0300",
      "performer": { "id": "john-snow", "email": "john.snow@runrun.it" },
      "data": {
        "comment": {
          "id": 8548,
          "commentable_type": "Project",
          "commentable": {
            "id": 985,
            "project_sub_group": { "id": 3846 },
            "project_group": { "id": 6528 },
            "time_worked": 0,
            "client": { "id": 5849 },
            "url": "http://localhost:3000/pt-BR/company/projects/985"
          },
          "text": "New comment edited.",
          "channel_name": nil,
          "created_at": "2024-10-09 08:53:04 -0300",
          "edited_at": "2024-10-09 08:53:54 -0300",
          "user": { "id": "john-snow", "email": "john.snow@runrun.it" },
          "guest": nil,
          "mentions": {
            "users": [],
            "tasks": []
          }
        }
      }
    }

client:create

    {
      "event": "client:create",
      "happened_at": "2024-10-09 08:50:38 -0300",
      "performer": { "id": "john-snow", "email": "john.snow@runrun.it" },
      "data": {
        "client": {
          "id": 5849,
          "url": "http://localhost:3000/pt-BR/company/clients/5849"
        }
      }
    }

team:comment:create

    {
      "event": "team:comment:create",
      "happened_at": "2024-10-09 08:57:28 -0300",
      "performer": { "id": "john-snow", "email": "john.snow@runrun.it" },
      "data": {
        "comment": {
          "id": 3655,
          "commentable_type": "Team",
          "commentable": { "id": 254, "name": "Team name" },
          "text": "New comment",
          "channel_name": nil,
          "created_at": "2024-10-09 08:57:26 -0300",
          "edited_at": nil,
          "user": { "id": "john-snow", "email": "john.snow@runrun.it" },
          "guest": nil,
          "mentions": {
            "users": [],
            "tasks": []
          }
        }
      }
    }

team:comment:update

    {
      "event": "team:comment:update",
      "happened_at": "2024-10-09 08:58:42 -0300",
      "performer": { "id": "john-snow", "email": "john.snow@runrun.it" },
      "data": {
        "comment": {
          "id": 3655,
          "commentable_type": "Team",
          "commentable": { "id": 254, "name": "Team name" },
          "text": "New comment edited",
          "channel_name": nil,
          "created_at": "2024-10-09 08:57:26 -0300",
          "edited_at": "2024-10-09 08:58:40 -0300",
          "user": { "id": "john-snow", "email": "john.snow@runrun.it" },
          "guest": nil,
          "mentions": {
            "users": [],
            "tasks": []
          }
        }
      }
    }

enterprise:comment:create

    {
      "event": "enterprise:comment:create",
      "happened_at": "2024-10-09 09:00:55 -0300",
      "performer": { "id": "john-snow", "email": "john.snow@runrun.it" },
      "data": {
        "comment": {
          "id": 25478,
          "commentable_type": "Enterprise",
          "commentable": {"id": "runrun-it", "name": "Runrun.it"},
          "text": "New Comment",
          "channel_name": nil,
          "created_at": "2024-10-09 08:59:19 -0300",
          "edited_at": nil,
          "user": { "id": "john-snow", "email": "john.snow@runrun.it" },
          "guest": nil,
          "mentions": {
            "users": [],
            "tasks": []
          }
        }
      }
    }

enterprise:comment:update

    {
      "event": "enterprise:comment:update",
      "happened_at": "2024-10-09 09:03:45 -0300",
      "performer": { "id": "john-snow", "email": "john.snow@runrun.it" },
      "data": {
        "comment": {
          "id": 25478,
          "commentable_type": "Enterprise",
          "commentable": {"id": "runrun-it", "name": "Runrun.it"},
          "text": "New Comment edited",
          "channel_name": nil,
          "created_at": "2024-10-09 08:59:19 -0300",
          "edited_at": "2024-10-09 09:02:15 -0300",
          "user": { "id": "john-snow", "email": "john.snow@runrun.it" },
          "guest": nil,
          "mentions": {
            "users": [],
            "tasks": []
          }
        }
      }
    }

document:comment:create

    {
      "event": "document:comment:create",
      "happened_at": "2024-10-09 09:06:23 -0300",
      "performer": { "id": "john-snow", "email": "john.snow@runrun.it" },
      "data": {
        "comment": {
          "id": 25415,
          "commentable_type": "Document",
          "commentable": {"id": 35155, "file_name": "Document.pdf"},
          "text": "Comment text",
          "channel_name": "guest",
          "created_at": "2024-10-09 09:06:20 -0300",
          "edited_at": nil,
          "user": { "id": "john-snow", "email": "john.snow@runrun.it" },
          "guest": nil,
          "mentions": {
            "users": [],
            "tasks": []
          }
        }
      }
    }

document:comment:update

    {
      "event": "document:comment:update",
      "happened_at": "2024-10-09 09:09:03 -0300",
      "performer": { "id": "john-snow", "email": "john.snow@runrun.it" },
      "data": {
        "comment": {
          "id": 25415,
          "commentable_type": "Document",
          "commentable": {"id": 35155, "file_name": "Document.pdf"},
          "text": "Comment text",
          "channel_name": "guest",
          "created_at": "2024-10-09 09:06:20 -0300",
          "edited_at": nil,
          "user": { "id": "john-snow", "email": "john.snow@runrun.it" },
          "guest": nil,
          "mentions": {
            "users": [],
            "tasks": []
          }
        }
      }
    }

Contacting API Support

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

Board Stages

GET

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

List all board stages

Parameters

Name	Description	type
sort	Sort by column	string
sort_dir	Sort direction ('asc' or 'desc')	string
search_term	Filter by term	string
stage_group	Filter by stage group ('opened' or 'closed')	string

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 -g "https://runrun.it/api/v1.0/boards/1/stages" -X GET \
	-H "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Response Fields

Name	Description	type
id	Board stage id	integer
name	Board stage name	string
description	Board stage description	string
stage_group	Board stage group ('opened' or 'closed')	enum
board_id	Board id	integer
position	Board stage position in group	integer
last_editor_name	Name of last editor	string
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
use_lead_time	Returns 'true' if board stage use lead time	boolean
user_settings	User settings for board stage	hash
use_elapsed_time	Returns 'true' if board stage use elapsed time	boolean
sla_elapsed_time	SLA elapsed time	integer
sla_elapsed_time_unit	SLA time unit	string
use_last_activity	Returns 'true' if board stage use last activity	boolean
sla_last_activity_time	SLA last activity time	integer
sla_last_activity_time_unit	SLA last activity time unit	string
is_default	[Deprecated] Not used anymore	boolean
is_delivered	[Deprecated] Use 'stage_group' instead	boolean
status_group	[Deprecated] Use 'stage_group' instead	enum

Status

Headers

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

Body

[
  {
    "id": 4,
    "name": "Board Stage 166",
    "description": null,
    "stage_group": "opened",
    "board_id": 1,
    "position": null,
    "last_editor_name": null,
    "is_following": false,
    "use_latency_time": true,
    "use_scrum_points": true,
    "use_lead_time": true,
    "use_elapsed_time": false,
    "sla_elapsed_time": null,
    "sla_elapsed_time_unit": null,
    "use_last_activity": false,
    "sla_last_activity_time": null,
    "sla_last_activity_time_unit": null,
    "is_default": false,
    "is_delivered": false,
    "status_group": "assigned",
    "fields": [

    ]
  },
  {
    "id": 3,
    "name": "Stage Closed 1",
    "description": null,
    "stage_group": "closed",
    "board_id": 1,
    "position": 1,
    "last_editor_name": "Coyote 77",
    "is_following": false,
    "use_latency_time": true,
    "use_scrum_points": true,
    "use_lead_time": null,
    "use_elapsed_time": false,
    "sla_elapsed_time": null,
    "sla_elapsed_time_unit": null,
    "use_last_activity": false,
    "sla_last_activity_time": null,
    "sla_last_activity_time_unit": null,
    "is_default": false,
    "is_delivered": true,
    "status_group": "done",
    "fields": [

    ]
  },
  {
    "id": 2,
    "name": "Stage Opened 2",
    "description": null,
    "stage_group": "opened",
    "board_id": 1,
    "position": 2,
    "last_editor_name": "Coyote 77",
    "is_following": false,
    "use_latency_time": true,
    "use_scrum_points": true,
    "use_lead_time": true,
    "use_elapsed_time": false,
    "sla_elapsed_time": null,
    "sla_elapsed_time_unit": null,
    "use_last_activity": false,
    "sla_last_activity_time": null,
    "sla_last_activity_time_unit": null,
    "is_default": false,
    "is_delivered": false,
    "status_group": "assigned",
    "fields": [

    ]
  },
  {
    "id": 1,
    "name": "Stage Opened 1",
    "description": null,
    "stage_group": "opened",
    "board_id": 1,
    "position": 1,
    "last_editor_name": "Coyote 77",
    "is_following": false,
    "use_latency_time": true,
    "use_scrum_points": true,
    "use_lead_time": true,
    "use_elapsed_time": false,
    "sla_elapsed_time": null,
    "sla_elapsed_time_unit": null,
    "use_last_activity": false,
    "sla_last_activity_time": null,
    "sla_last_activity_time_unit": null,
    "is_default": false,
    "is_delivered": false,
    "status_group": "assigned",
    "fields": [

    ]
  }
]

GET

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

Show a board stage

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 -g "https://runrun.it/api/v1.0/boards/1/stages/4" -X GET \
	-H "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Response Fields

Name	Description	type
id	Board stage id	integer
name	Board stage name	string
description	Board stage description	string
stage_group	Board stage group ('opened' or 'closed')	enum
board_id	Board id	integer
position	Board stage position in group	integer
last_editor_name	Name of last editor	string
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
use_lead_time	Returns 'true' if board stage use lead time	boolean
user_settings	User settings for board stage	hash
use_elapsed_time	Returns 'true' if board stage use elapsed time	boolean
sla_elapsed_time	SLA elapsed time	integer
sla_elapsed_time_unit	SLA time unit	string
use_last_activity	Returns 'true' if board stage use last activity	boolean
sla_last_activity_time	SLA last activity time	integer
sla_last_activity_time_unit	SLA last activity time unit	string
is_default	[Deprecated] Not used anymore	boolean
is_delivered	[Deprecated] Use 'stage_group' instead	boolean
status_group	[Deprecated] Use 'stage_group' instead	enum

Status

Headers

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

Body

{
  "id": 4,
  "name": "Board Stage 167",
  "description": null,
  "stage_group": "opened",
  "board_id": 1,
  "position": null,
  "last_editor_name": null,
  "is_following": false,
  "use_latency_time": true,
  "use_scrum_points": true,
  "use_lead_time": true,
  "use_elapsed_time": false,
  "sla_elapsed_time": null,
  "sla_elapsed_time_unit": null,
  "use_last_activity": false,
  "sla_last_activity_time": null,
  "sla_last_activity_time_unit": null,
  "is_default": false,
  "is_delivered": false,
  "status_group": "assigned",
  "fields": [

  ]
}

POST

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

Create a board stage

Parameters

Name	Description	type	default
board_stage[name] required	Board stage name	string
board_stage[stage_group] required	Board stage group ('opened' or 'closed')	enum	opened
board_stage[description]	Board stage description	string
board_stage[position]	Board stage position in group	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 168",
    "position": null,
    "stage_group": "opened",
    "description": "Stage description"
  }
}

cURL

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

Response

Simulated Response

Status

Headers

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

Body

{
  "id": 4,
  "name": "Board Stage 168",
  "description": "Stage description",
  "stage_group": "opened",
  "board_id": 1,
  "position": 3,
  "last_editor_name": "Coyote 79",
  "is_following": false,
  "use_latency_time": true,
  "use_scrum_points": true,
  "use_lead_time": true,
  "use_elapsed_time": false,
  "sla_elapsed_time": null,
  "sla_elapsed_time_unit": null,
  "use_last_activity": false,
  "sla_last_activity_time": null,
  "sla_last_activity_time_unit": null,
  "is_default": false,
  "is_delivered": false,
  "status_group": "assigned",
  "fields": [

  ]
}

PUT

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

Update a board stage

Parameters

Name	Description	type
board_stage[name]	Board stage name	string
board_stage[description]	Board stage description	string
board_stage[fields_data]	Board stage fields data

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",
    "description": "New description",
    "fields_data": [
      {
        "field_id": "custom_4"
      }
    ]
  }
}

cURL

curl "https://runrun.it/api/v1.0/boards/1/stages/4" -d '{"board_stage":{"name":"New Board","description":"New description","fields_data":[{"field_id":"custom_4"}]}}' -X PUT \
	-H "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

{
  "id": 4,
  "name": "New Board",
  "description": "New description",
  "stage_group": "opened",
  "board_id": 1,
  "position": null,
  "last_editor_name": "Coyote 80",
  "is_following": false,
  "use_latency_time": true,
  "use_scrum_points": true,
  "use_lead_time": true,
  "use_elapsed_time": false,
  "sla_elapsed_time": null,
  "sla_elapsed_time_unit": null,
  "use_last_activity": false,
  "sla_last_activity_time": null,
  "sla_last_activity_time_unit": null,
  "is_default": false,
  "is_delivered": false,
  "status_group": "assigned",
  "fields": [
    {
      "field_id": "custom_4",
      "field_label": "Field 3",
      "field_type": "short_text",
      "field_status": "active",
      "position": null,
      "is_required": false
    }
  ]
}

DELETE

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

Destroy a board stage

POST

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

Move a board stage to another group position

Name	Description	type
position required	Board stage position in group	integer

POST

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

Update to use (or not) latency time

Name	Description	type
use_latency_time required	Returns 'true' if board stage latency time is being calculated	boolean

POST

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

Update to use (or not) scrum points

Name	Description	type
use_scrum_points required	Returns 'true' if task points should be shown	boolean

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 -g "https://runrun.it/api/v1.0/checklists/1/items" -X GET \
	-H "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Response Fields

Name	Description	type
id	ID of checklist item	integer
description	Item description	string
position	Item position	integer
checked	Checklist item was completed?	boolean
checker_id	ID of last user who marked checklist item as completed	string
checked_at	Time when checklist item was marked as completed	datetime
checklist_id	ID of the checklist the item belongs to	integer

Status

Headers

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

Body

[
  {
    "id": 1,
    "description": "Paper clips",
    "position": 1,
    "checked": false,
    "checker_id": "coyote-141",
    "checked_at": null,
    "checklist_id": 1
  },
  {
    "id": 2,
    "description": "Cups",
    "position": 2,
    "checked": false,
    "checker_id": "coyote-139",
    "checked_at": "2024-11-08T14:00:31-03:00",
    "checklist_id": 1
  }
]

GET

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

Show a checklist item

POST

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

Create a checklist item

Name	Description	type
checklist_item[description] required	Item description	string
checklist_item[checked]	Checklist item was completed?	boolean
checklist_item[position]	Item position	integer

PUT

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

Update a checklist item

Name	Description	type
checklist_item[description]	Item description	string
checklist_item[checked]	Checklist item was completed?	boolean
checklist_item[position]	Item position	integer

DELETE

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

Destroy a checklist item

Checklists

GET

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

Show a checklist from a task

Name	Description	type
id	ID of checklist	integer
title	Checklist title	string
creator_id	ID of user who created this checklist	string
task_id	ID of the task the checklist belongs to	integer
task_template_id	ID of the task template the checklist belongs to	integer

POST

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

Create a checklist from a task

Name	Description	type
checklist[title] required	Checklist title	string

PUT

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

Update a checklist from a task

Name	Description	type
checklist[title]	Checklist title	string

DELETE

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

Destroy a checklist from a task

GET

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

Show a checklist from a task template

Name	Description	type
id	ID of checklist	integer
title	Checklist title	string
creator_id	ID of user who created this checklist	string
task_id	ID of the task the checklist belongs to	integer
task_template_id	ID of the task template the checklist belongs to	integer

POST

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

Create a checklist from a task template

Name	Description	type
checklist[title] required	Checklist title	string

PUT

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

Update a checklist from a task template

Name	Description	type
checklist[title]	Checklist title	string

DELETE

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

Destroy a checklist from a task template

Clients

GET

/api/v1.0/clients

List clients

Parameters

Name	Description	type
sort	Sort by column	string
sort_dir	Sort direction ('asc' or 'desc')	string
search_term	Filter by term	string
filter_id	Filter by an existing filter	integer
is_visible	Filter by visible clients	boolean

Request

Route

GET /api/v1.0/clients

Headers

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

cURL

curl -g "https://runrun.it/api/v1.0/clients" -X GET \
	-H "Version: HTTP/1.0" \
	-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 time (in 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' instead	integer
project_groups	[Deprecated] Not used anymore	array

Status

Headers

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

Body

[
  {
    "id": 1,
    "name": "Test client 111",
    "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": "2024-11-08T14:01:20-03:00",
        "updated_at": "2024-11-08T14:01:20-03:00"
      }
    ],
    "project_ids": [

    ]
  }
]

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 -g "https://runrun.it/api/v1.0/clients/1" -X GET \
	-H "Version: HTTP/1.0" \
	-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 time (in 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' instead	integer
project_groups	[Deprecated] Not used anymore	array

Status

Headers

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

Body

{
  "id": 1,
  "name": "Test client 112",
  "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": "2024-11-08T14:01:21-03:00",
      "updated_at": "2024-11-08T14:01:21-03:00"
    }
  ],
  "project_ids": [

  ]
}

POST

/api/v1.0/clients

Create a client

Parameters

Name	Description	type
client[name] required	Client's name	string
client[is_visible]	Client is currently visible to be used	boolean
client[budgeted_hours_month]	Budgeted hours per month	decimal
client[budgeted_cost_month]	Budgeted cost per month	decimal
client[custom_field]	Custom field	string

Request

Route

POST /api/v1.0/clients

Headers

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

Body

{
  "client": {
    "name": "My Client",
    "is_visible": true,
    "budgeted_hours_month": 10000,
    "budgeted_cost_month": 2000.5,
    "custom_field": "custom field"
  }
}

cURL

curl "https://runrun.it/api/v1.0/clients" -d '{"client":{"name":"My Client","is_visible":true,"budgeted_hours_month":10000,"budgeted_cost_month":2000.5,"custom_field":"custom field"}}' -X POST \
	-H "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

{
  "id": 1,
  "name": "My Client",
  "custom_field": "custom field",
  "is_visible": true,
  "budgeted_hours_month": 10000,
  "budgeted_cost_month": 2000.5,
  "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": "2024-11-08T14:01:23-03:00",
      "updated_at": "2024-11-08T14:01:23-03:00"
    }
  ],
  "project_ids": [

  ]
}

PUT

/api/v1.0/clients/:id

Update a client

Parameters

Name	Description	type
client[name]	Client's name	string
client[is_visible]	Client is currently visible to be used	boolean
client[budgeted_hours_month]	Budgeted hours per month	decimal
client[budgeted_cost_month]	Budgeted cost per month	decimal
client[custom_field]	Custom field	string

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 "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 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": "2024-11-08T14:01:24-03:00",
      "updated_at": "2024-11-08T14:01:24-03:00"
    }
  ],
  "project_ids": [

  ]
}

GET

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

List all budgets

Name	Description	type
client_id	Client id	integer
month	Year-Month	string
time	Include others	integer
cost	Cost	string

POST

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

when a budget not exists, creates a new budget

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 -g "https://runrun.it/api/v1.0/tasks/1/comments" -X GET \
	-H "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

[
  {
    "id": 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": "2024-11-08T14:01:32-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": [

    ],
    "is_automation_message": false
  },
  {
    "id": 1,
    "user_id": "coyote-228",
    "guest_id": null,
    "is_system_message": false,
    "text": "Comment text",
    "commenter_name": "Coyote 228",
    "children_count": 0,
    "commentable_id": 1,
    "commentable_type": "Task",
    "created_at": "2024-11-08T14:01: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": 1,
    "comment_id": null,
    "team_id": null,
    "enterprise_id": null,
    "document_id": null,
    "is_legacy": false,
    "media": null,
    "documents": [

    ],
    "reactions": [

    ],
    "is_automation_message": false
  }
]

GET

/api/v1.0/comments/:id

Show a specific comment

POST

/api/v1.0/comments

Create a new comment

POST

/api/v1.0/comments

Create a new comment

POST

/api/v1.0/comments

Create a new project comment

PUT

/api/v1.0/comments/:id

Update a comment

DELETE

/api/v1.0/comments/:id

Destroy a comment

POST

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

Reaction to a comment

Dashboard::Widgets

GET

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

List all widgets for a board dashboard

GET

/api/v1.0/widgets/:id

List a choosen widget for a board dashboard

POST

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

Create a widget

PUT

/api/v1.0/widgets/:id

Update a widget for a board dashboard

Request

Route

PUT /api/v1.0/widgets/1

Headers

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

Body

{
  "widget": {
    "name": "New widget name",
    "kind": "indicator",
    "restriction": [
      {
        "column_id": "is_urgent",
        "operator": "is_true",
        "value": null,
        "group_id": 0
      }
    ],
    "parameters": {
      "board_id": 1,
      "axes": [
        {
          "source": "tasks"
        }
      ]
    }
  }
}

cURL

curl "https://runrun.it/api/v1.0/widgets/1" -d '{"widget":{"name":"New widget name","kind":"indicator","restriction":[{"column_id":"is_urgent","operator":"is_true","value":null,"group_id":0}],"parameters":{"board_id":1,"axes":[{"source":"tasks"}]}}}' -X PUT \
	-H "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

{
  "id": 1,
  "dashboard_id": 1,
  "dashboard_widget_id": 1,
  "name": "New widget name",
  "description": null,
  "kind": "indicator",
  "user_id": "coyote-256",
  "valid": true,
  "is_limited_by_plan": true,
  "plan_limitations": [
    "plan_period_to_analyze_limitation"
  ],
  "aggregation": {
    "function": "count"
  },
  "restriction": [
    {
      "column_id": "is_urgent",
      "operator": "is_true",
      "group_id": 0,
      "value": null,
      "valid": true
    }
  ],
  "conditions": [
    {
      "column_id": "is_urgent",
      "operator": "is_true",
      "group_id": 0,
      "value": null,
      "valid": true
    }
  ],
  "grouping": [

  ],
  "sorting": [

  ],
  "parameters": {
    "board_id": 1,
    "axes": [
      {
        "source": "tasks"
      }
    ]
  },
  "refreshed_at": null,
  "grid_x": 11,
  "grid_y": 11,
  "grid_w": 1,
  "grid_h": 1,
  "data_url": "/api/widgets/1/tasks",
  "data_export_url": "/api/widgets/1/export",
  "custom_dashboard_fields": [

  ]
}

DELETE

/api/v1.0/widgets/:id

Destroy a widget

POST

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

Reorder all widgets for the selected dashboard

Request

Route

POST /api/v1.0/dashboards/1/widgets/reorder

Headers

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

Body

{
  "dashboard_widgets": [
    {
      "id": 1,
      "grid_x": 3,
      "grid_y": 1,
      "grid_w": 1,
      "grid_h": 1
    },
    {
      "id": 2,
      "grid_x": 2,
      "grid_y": 1,
      "grid_w": 1,
      "grid_h": 1
    },
    {
      "id": 3,
      "grid_x": 1,
      "grid_y": 1,
      "grid_w": 1,
      "grid_h": 1
    }
  ]
}

cURL

curl "https://runrun.it/api/v1.0/dashboards/1/widgets/reorder" -d '{"dashboard_widgets":[{"id":1,"grid_x":3,"grid_y":1,"grid_w":1,"grid_h":1},{"id":2,"grid_x":2,"grid_y":1,"grid_w":1,"grid_h":1},{"id":3,"grid_x":1,"grid_y":1,"grid_w":1,"grid_h":1}]}' -X POST \
	-H "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

[
  {
    "id": 1,
    "dashboard_id": 1,
    "dashboard_widget_id": 1,
    "name": "Widget 16",
    "description": null,
    "kind": "project_indicator",
    "user_id": "coyote-258",
    "valid": true,
    "is_limited_by_plan": true,
    "plan_limitations": [
      "plan_period_to_analyze_limitation"
    ],
    "aggregation": {
    },
    "restriction": [

    ],
    "conditions": [

    ],
    "grouping": [

    ],
    "sorting": [

    ],
    "parameters": {
    },
    "refreshed_at": null,
    "grid_x": 3,
    "grid_y": 1,
    "grid_w": 1,
    "grid_h": 1,
    "data_url": "",
    "data_export_url": "",
    "custom_dashboard_fields": [

    ]
  },
  {
    "id": 2,
    "dashboard_id": 1,
    "dashboard_widget_id": 2,
    "name": "Widget 17",
    "description": null,
    "kind": "project_indicator",
    "user_id": "coyote-258",
    "valid": true,
    "is_limited_by_plan": true,
    "plan_limitations": [
      "plan_period_to_analyze_limitation"
    ],
    "aggregation": {
    },
    "restriction": [

    ],
    "conditions": [

    ],
    "grouping": [

    ],
    "sorting": [

    ],
    "parameters": {
    },
    "refreshed_at": null,
    "grid_x": 2,
    "grid_y": 1,
    "grid_w": 1,
    "grid_h": 1,
    "data_url": "",
    "data_export_url": "",
    "custom_dashboard_fields": [

    ]
  },
  {
    "id": 3,
    "dashboard_id": 1,
    "dashboard_widget_id": 3,
    "name": "Widget 18",
    "description": null,
    "kind": "project_indicator",
    "user_id": "coyote-258",
    "valid": true,
    "is_limited_by_plan": true,
    "plan_limitations": [
      "plan_period_to_analyze_limitation"
    ],
    "aggregation": {
    },
    "restriction": [

    ],
    "conditions": [

    ],
    "grouping": [

    ],
    "sorting": [

    ],
    "parameters": {
    },
    "refreshed_at": null,
    "grid_x": 1,
    "grid_y": 1,
    "grid_w": 1,
    "grid_h": 1,
    "data_url": "",
    "data_export_url": "",
    "custom_dashboard_fields": [

    ]
  }
]

GET

/api/v1.0/dashboards/:dashboard_id/widgets/form_setup

List all available vertical options for a board dashboard

Request

Route

GET /api/v1.0/dashboards/1/widgets/form_setup

Headers

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

cURL

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

Response

Simulated Response

Status

Headers

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

Body

[
  {
    "id": "tasks",
    "column_id": "id",
    "field_type": "tasks",
    "category": "recommended",
    "label": "Tasks",
    "description": "Number of tasks on this board",
    "is_available": true,
    "preview_url": "/api/dashboards/1/widgets/tasks",
    "functions": [
      "count"
    ],
    "horizontal_options": [
      {
        "label": "Client",
        "id": "client",
        "column_types": [
          "client_id",
          "short_text"
        ],
        "details": {
        }
      },
      {
        "label": "Created by",
        "id": "user",
        "column_types": [
          "user_slug",
          "short_text"
        ],
        "details": {
        }
      },
      {
        "label": "Creation date",
        "id": "created_at",
        "column_types": [
          "datetime"
        ],
        "details": {
        }
      },
      {
        "label": "Current stage",
        "id": "board_stage",
        "column_types": [
          "short_text"
        ],
        "details": {
        }
      },
      {
        "label": "Delay",
        "id": "overdue",
        "column_types": [
          "overdue"
        ],
        "details": {
          "options": [
            {
              "id": "on_schedule",
              "label": "without delay"
            },
            {
              "id": "soft_overdue",
              "label": "estimated delay"
            },
            {
              "id": "hard_overdue",
              "label": "with delay"
            }
          ]
        }
      },
      {
        "label": "Delivery date",
        "id": "close_date",
        "column_types": [
          "datetime"
        ],
        "details": {
        }
      },
      {
        "label": "Desired delivery date",
        "id": "desired_date",
        "column_types": [
          "datetime"
        ],
        "details": {
        }
      },
      {
        "label": "Desired start date",
        "id": "desired_start_date",
        "column_types": [
          "datetime"
        ],
        "details": {
        }
      },
      {
        "label": "Estimated delivery date",
        "id": "estimated_delivery_date",
        "column_types": [
          "datetime"
        ],
        "details": {
        }
      },
      {
        "label": "Expected time (SLA) exceeded",
        "id": "is_board_stage_sla_elapsed_time_overdue",
        "column_types": [
          "boolean"
        ],
        "details": {
        }
      },
      {
        "label": "Inactivity timeout exceeded",
        "id": "is_board_stage_sla_last_activity_time_overdue",
        "column_types": [
          "boolean"
        ],
        "details": {
        }
      },
      {
        "label": "Project",
        "id": "project",
        "column_types": [
          "project_id",
          "short_text"
        ],
        "details": {
        }
      },
      {
        "label": "Shared",
        "id": "is_shared",
        "column_types": [
          "boolean"
        ],
        "details": {
        }
      },
      {
        "label": "Start date",
        "id": "start_date",
        "column_types": [
          "datetime"
        ],
        "details": {
        }
      },
      {
        "label": "State",
        "id": "state",
        "column_types": [
          "task_state"
        ],
        "details": {
          "options": [
            {
              "id": "closed",
              "label": "completed"
            },
            {
              "id": "queued",
              "label": "pending"
            },
            {
              "id": "working_on",
              "label": "in development"
            },
            {
              "id": "not_assigned",
              "label": "unassigned"
            }
          ]
        }
      },
      {
        "label": "Tags",
        "id": "tags",
        "column_types": [
          "tags"
        ],
        "details": {
        }
      },
      {
        "label": "Teams assigned",
        "id": "teams",
        "column_types": [
          "team_ids"
        ],
        "details": {
        }
      },
      {
        "label": "Type",
        "id": "task_type",
        "column_types": [
          "type_id",
          "short_text"
        ],
        "details": {
        }
      },
      {
        "label": "Urgent",
        "id": "is_urgent",
        "column_types": [
          "boolean"
        ],
        "details": {
        }
      },
      {
        "label": "Users assigned",
        "id": "assignees",
        "column_types": [
          "user_slugs"
        ],
        "details": {
        }
      }
    ],
    "period_to_analyze_options": [
      {
        "label": "From the beginning",
        "id": null,
        "required_plan": "enterprise"
      },
      {
        "label": "Creation date",
        "id": "created_at",
        "operators": [
          {
            "label": "in the last",
            "id": "in_the_last",
            "type": "list",
            "items": [
              {
                "label": "7 days",
                "id": "seven_days",
                "required_plan": null
              },
              {
                "label": "15 days",
                "id": "fifteen_days",
                "required_plan": null
              },
              {
                "label": "30 days",
                "id": "thirty_days",
                "required_plan": null
              },
              {
                "label": "1 year",
                "id": "one_year",
                "required_plan": "enterprise"
              }
            ]
          },
          {
            "label": "in the next",
            "id": "in_the_next",
            "type": "list",
            "items": [
              {
                "label": "7 days",
                "id": "seven_days",
                "required_plan": null
              },
              {
                "label": "15 days",
                "id": "fifteen_days",
                "required_plan": null
              },
              {
                "label": "30 days",
                "id": "thirty_days",
                "required_plan": null
              },
              {
                "label": "1 year",
                "id": "one_year",
                "required_plan": "enterprise"
              }
            ]
          },
          {
            "label": "relative day",
            "id": "equals_relative_date",
            "type": "list",
            "items": [
              {
                "label": "yesterday",
                "id": "yesterday"
              },
              {
                "label": "today",
                "id": "today"
              },
              {
                "label": "tomorrow",
                "id": "tomorrow"
              }
            ]
          }
        ]
      },
      {
        "label": "Delivery date",
        "id": "close_date",
        "operators": [
          {
            "label": "in the last",
            "id": "in_the_last",
            "type": "list",
            "items": [
              {
                "label": "7 days",
                "id": "seven_days",
                "required_plan": null
              },
              {
                "label": "15 days",
                "id": "fifteen_days",
                "required_plan": null
              },
              {
                "label": "30 days",
                "id": "thirty_days",
                "required_plan": null
              },
              {
                "label": "1 year",
                "id": "one_year",
                "required_plan": "enterprise"
              }
            ]
          },
          {
            "label": "in the next",
            "id": "in_the_next",
            "type": "list",
            "items": [
              {
                "label": "7 days",
                "id": "seven_days",
                "required_plan": null
              },
              {
                "label": "15 days",
                "id": "fifteen_days",
                "required_plan": null
              },
              {
                "label": "30 days",
                "id": "thirty_days",
                "required_plan": null
              },
              {
                "label": "1 year",
                "id": "one_year",
                "required_plan": "enterprise"
              }
            ]
          },
          {
            "label": "relative day",
            "id": "equals_relative_date",
            "type": "list",
            "items": [
              {
                "label": "yesterday",
                "id": "yesterday"
              },
              {
                "label": "today",
                "id": "today"
              },
              {
                "label": "tomorrow",
                "id": "tomorrow"
              }
            ]
          }
        ]
      },
      {
        "label": "Desired delivery date",
        "id": "desired_date",
        "operators": [
          {
            "label": "in the last",
            "id": "in_the_last",
            "type": "list",
            "items": [
              {
                "label": "7 days",
                "id": "seven_days",
                "required_plan": null
              },
              {
                "label": "15 days",
                "id": "fifteen_days",
                "required_plan": null
              },
              {
                "label": "30 days",
                "id": "thirty_days",
                "required_plan": null
              },
              {
                "label": "1 year",
                "id": "one_year",
                "required_plan": "enterprise"
              }
            ]
          },
          {
            "label": "in the next",
            "id": "in_the_next",
            "type": "list",
            "items": [
              {
                "label": "7 days",
                "id": "seven_days",
                "required_plan": null
              },
              {
                "label": "15 days",
                "id": "fifteen_days",
                "required_plan": null
              },
              {
                "label": "30 days",
                "id": "thirty_days",
                "required_plan": null
              },
              {
                "label": "1 year",
                "id": "one_year",
                "required_plan": "enterprise"
              }
            ]
          },
          {
            "label": "relative day",
            "id": "equals_relative_date",
            "type": "list",
            "items": [
              {
                "label": "yesterday",
                "id": "yesterday"
              },
              {
                "label": "today",
                "id": "today"
              },
              {
                "label": "tomorrow",
                "id": "tomorrow"
              }
            ]
          }
        ]
      },
      {
        "label": "Desired start date",
        "id": "desired_start_date",
        "operators": [
          {
            "label": "in the last",
            "id": "in_the_last",
            "type": "list",
            "items": [
              {
                "label": "7 days",
                "id": "seven_days",
                "required_plan": null
              },
              {
                "label": "15 days",
                "id": "fifteen_days",
                "required_plan": null
              },
              {
                "label": "30 days",
                "id": "thirty_days",
                "required_plan": null
              },
              {
                "label": "1 year",
                "id": "one_year",
                "required_plan": "enterprise"
              }
            ]
          },
          {
            "label": "in the next",
            "id": "in_the_next",
            "type": "list",
            "items": [
              {
                "label": "7 days",
                "id": "seven_days",
                "required_plan": null
              },
              {
                "label": "15 days",
                "id": "fifteen_days",
                "required_plan": null
              },
              {
                "label": "30 days",
                "id": "thirty_days",
                "required_plan": null
              },
              {
                "label": "1 year",
                "id": "one_year",
                "required_plan": "enterprise"
              }
            ]
          },
          {
            "label": "relative day",
            "id": "equals_relative_date",
            "type": "list",
            "items": [
              {
                "label": "yesterday",
                "id": "yesterday"
              },
              {
                "label": "today",
                "id": "today"
              },
              {
                "label": "tomorrow",
                "id": "tomorrow"
              }
            ]
          }
        ]
      },
      {
        "label": "Estimated delivery date",
        "id": "estimated_delivery_date",
        "operators": [
          {
            "label": "in the last",
            "id": "in_the_last",
            "type": "list",
            "items": [
              {
                "label": "7 days",
                "id": "seven_days",
                "required_plan": null
              },
              {
                "label": "15 days",
                "id": "fifteen_days",
                "required_plan": null
              },
              {
                "label": "30 days",
                "id": "thirty_days",
                "required_plan": null
              },
              {
                "label": "1 year",
                "id": "one_year",
                "required_plan": "enterprise"
              }
            ]
          },
          {
            "label": "in the next",
            "id": "in_the_next",
            "type": "list",
            "items": [
              {
                "label": "7 days",
                "id": "seven_days",
                "required_plan": null
              },
              {
                "label": "15 days",
                "id": "fifteen_days",
                "required_plan": null
              },
              {
                "label": "30 days",
                "id": "thirty_days",
                "required_plan": null
              },
              {
                "label": "1 year",
                "id": "one_year",
                "required_plan": "enterprise"
              }
            ]
          },
          {
            "label": "relative day",
            "id": "equals_relative_date",
            "type": "list",
            "items": [
              {
                "label": "yesterday",
                "id": "yesterday"
              },
              {
                "label": "today",
                "id": "today"
              },
              {
                "label": "tomorrow",
                "id": "tomorrow"
              }
            ]
          }
        ]
      },
      {
        "label": "Last update",
        "id": "last_activity_at",
        "operators": [
          {
            "label": "in the last",
            "id": "in_the_last",
            "type": "list",
            "items": [
              {
                "label": "7 days",
                "id": "seven_days",
                "required_plan": null
              },
              {
                "label": "15 days",
                "id": "fifteen_days",
                "required_plan": null
              },
              {
                "label": "30 days",
                "id": "thirty_days",
                "required_plan": null
              },
              {
                "label": "1 year",
                "id": "one_year",
                "required_plan": "enterprise"
              }
            ]
          },
          {
            "label": "in the next",
            "id": "in_the_next",
            "type": "list",
            "items": [
              {
                "label": "7 days",
                "id": "seven_days",
                "required_plan": null
              },
              {
                "label": "15 days",
                "id": "fifteen_days",
                "required_plan": null
              },
              {
                "label": "30 days",
                "id": "thirty_days",
                "required_plan": null
              },
              {
                "label": "1 year",
                "id": "one_year",
                "required_plan": "enterprise"
              }
            ]
          },
          {
            "label": "relative day",
            "id": "equals_relative_date",
            "type": "list",
            "items": [
              {
                "label": "yesterday",
                "id": "yesterday"
              },
              {
                "label": "today",
                "id": "today"
              },
              {
                "label": "tomorrow",
                "id": "tomorrow"
              }
            ]
          }
        ]
      },
      {
        "label": "Start date",
        "id": "start_date",
        "operators": [
          {
            "label": "in the last",
            "id": "in_the_last",
            "type": "list",
            "items": [
              {
                "label": "7 days",
                "id": "seven_days",
                "required_plan": null
              },
              {
                "label": "15 days",
                "id": "fifteen_days",
                "required_plan": null
              },
              {
                "label": "30 days",
                "id": "thirty_days",
                "required_plan": null
              },
              {
                "label": "1 year",
                "id": "one_year",
                "required_plan": "enterprise"
              }
            ]
          },
          {
            "label": "in the next",
            "id": "in_the_next",
            "type": "list",
            "items": [
              {
                "label": "7 days",
                "id": "seven_days",
                "required_plan": null
              },
              {
                "label": "15 days",
                "id": "fifteen_days",
                "required_plan": null
              },
              {
                "label": "30 days",
                "id": "thirty_days",
                "required_plan": null
              },
              {
                "label": "1 year",
                "id": "one_year",
                "required_plan": "enterprise"
              }
            ]
          },
          {
            "label": "relative day",
            "id": "equals_relative_date",
            "type": "list",
            "items": [
              {
                "label": "yesterday",
                "id": "yesterday"
              },
              {
                "label": "today",
                "id": "today"
              },
              {
                "label": "tomorrow",
                "id": "tomorrow"
              }
            ]
          }
        ]
      }
    ],
    "period_to_compare_options": [
      {
        "id": "same_days_on_last_period",
        "required_plan": null
      },
      {
        "id": "same_period_on_previous_year",
        "required_plan": "enterprise"
      }
    ],
    "grouping_options": [
      {
        "label": "Client",
        "id": "client",
        "column_types": [
          "client_id",
          "short_text"
        ],
        "details": {
        }
      },
      {
        "label": "Created by",
        "id": "user",
        "column_types": [
          "user_slug",
          "short_text"
        ],
        "details": {
        }
      },
      {
        "label": "Current stage",
        "id": "board_stage",
        "column_types": [
          "short_text"
        ],
        "details": {
        }
      },
      {
        "label": "Delay",
        "id": "overdue",
        "column_types": [
          "overdue"
        ],
        "details": {
          "options": [
            {
              "id": "on_schedule",
              "label": "without delay"
            },
            {
              "id": "soft_overdue",
              "label": "estimated delay"
            },
            {
              "id": "hard_overdue",
              "label": "with delay"
            }
          ]
        }
      },
      {
        "label": "Expected time (SLA) exceeded",
        "id": "is_board_stage_sla_elapsed_time_overdue",
        "column_types": [
          "boolean"
        ],
        "details": {
        }
      },
      {
        "label": "Inactivity timeout exceeded",
        "id": "is_board_stage_sla_last_activity_time_overdue",
        "column_types": [
          "boolean"
        ],
        "details": {
        }
      },
      {
        "label": "Project",
        "id": "project",
        "column_types": [
          "project_id",
          "short_text"
        ],
        "details": {
        }
      },
      {
        "label": "Shared",
        "id": "is_shared",
        "column_types": [
          "boolean"
        ],
        "details": {
        }
      },
      {
        "label": "State",
        "id": "state",
        "column_types": [
          "task_state"
        ],
        "details": {
          "options": [
            {
              "id": "closed",
              "label": "completed"
            },
            {
              "id": "queued",
              "label": "pending"
            },
            {
              "id": "working_on",
              "label": "in development"
            },
            {
              "id": "not_assigned",
              "label": "unassigned"
            }
          ]
        }
      },
      {
        "label": "Tags",
        "id": "tags",
        "column_types": [
          "tags"
        ],
        "details": {
        }
      },
      {
        "label": "Teams assigned",
        "id": "teams",
        "column_types": [
          "team_ids"
        ],
        "details": {
        }
      },
      {
        "label": "Type",
        "id": "task_type",
        "column_types": [
          "type_id",
          "short_text"
        ],
        "details": {
        }
      },
      {
        "label": "Urgent",
        "id": "is_urgent",
        "column_types": [
          "boolean"
        ],
        "details": {
        }
      },
      {
        "label": "Users assigned",
        "id": "assignees",
        "column_types": [
          "user_slugs"
        ],
        "details": {
        }
      }
    ]
  },
  {
    "id": "task_trackings",
    "column_id": "task_trackings",
    "field_type": "time_trackings",
    "category": "recommended",
    "label": "Elapsed time",
    "description": "Time in the open stages",
    "is_available": true,
    "preview_url": "/api/dashboards/1/widgets/task_trackings",
    "functions": [
      "sum",
      "avg",
      "max",
      "min"
    ],
    "horizontal_options": [
      {
        "label": "Client",
        "id": "client",
        "column_types": [
          "client_id",
          "short_text"
        ],
        "details": {
        }
      },
      {
        "label": "Created by",
        "id": "user",
        "column_types": [
          "user_slug",
          "short_text"
        ],
        "details": {
        }
      },
      {
        "label": "Creation date",
        "id": "created_at",
        "column_types": [
          "datetime"
        ],
        "details": {
        }
      },
      {
        "label": "Current stage",
        "id": "board_stage",
        "column_types": [
          "short_text"
        ],
        "details": {
        }
      },
      {
        "label": "Delay",
        "id": "overdue",
        "column_types": [
          "overdue"
        ],
        "details": {
          "options": [
            {
              "id": "on_schedule",
              "label": "without delay"
            },
            {
              "id": "soft_overdue",
              "label": "estimated delay"
            },
            {
              "id": "hard_overdue",
              "label": "with delay"
            }
          ]
        }
      },
      {
        "label": "Delivery date",
        "id": "close_date",
        "column_types": [
          "datetime"
        ],
        "details": {
        }
      },
      {
        "label": "Desired delivery date",
        "id": "desired_date",
        "column_types": [
          "datetime"
        ],
        "details": {
        }
      },
      {
        "label": "Desired start date",
        "id": "desired_start_date",
        "column_types": [
          "datetime"
        ],
        "details": {
        }
      },
      {
        "label": "Estimated delivery date",
        "id": "estimated_delivery_date",
        "column_types": [
          "datetime"
        ],
        "details": {
        }
      },
      {
        "label": "Expected time (SLA) exceeded",
        "id": "is_board_stage_sla_elapsed_time_overdue",
        "column_types": [
          "boolean"
        ],
        "details": {
        }
      },
      {
        "label": "Inactivity timeout exceeded",
        "id": "is_board_stage_sla_last_activity_time_overdue",
        "column_types": [
          "boolean"
        ],
        "details": {
        }
      },
      {
        "label": "Project",
        "id": "project",
        "column_types": [
          "project_id",
          "short_text"
        ],
        "details": {
        }
      },
      {
        "label": "Shared",
        "id": "is_shared",
        "column_types": [
          "boolean"
        ],
        "details": {
        }
      },
      {
        "label": "Start date",
        "id": "start_date",
        "column_types": [
          "datetime"
        ],
        "details": {
        }
      },
      {
        "label": "State",
        "id": "state",
        "column_types": [
          "task_state"
        ],
        "details": {
          "options": [
            {
              "id": "closed",
              "label": "completed"
            },
            {
              "id": "queued",
              "label": "pending"
            },
            {
              "id": "working_on",
              "label": "in development"
            },
            {
              "id": "not_assigned",
              "label": "unassigned"
            }
          ]
        }
      },
      {
        "label": "Tags",
        "id": "tags",
        "column_types": [
          "tags"
        ],
        "details": {
        }
      },
      {
        "label": "Teams assigned",
        "id": "teams",
        "column_types": [
          "team_ids"
        ],
        "details": {
        }
      },
      {
        "label": "Type",
        "id": "task_type",
        "column_types": [
          "type_id",
          "short_text"
        ],
        "details": {
        }
      },
      {
        "label": "Urgent",
        "id": "is_urgent",
        "column_types": [
          "boolean"
        ],
        "details": {
        }
      },
      {
        "label": "Users assigned",
        "id": "assignees",
        "column_types": [
          "user_slugs"
        ],
        "details": {
        }
      }
    ],
    "period_to_analyze_options": [
      {
        "label": "From the beginning",
        "id": null,
        "required_plan": "enterprise"
      },
      {
        "label": "Delivery date",
        "id": "close_date",
        "operators": [
          {
            "label": "in the last",
            "id": "in_the_last",
            "type": "list",
            "items": [
              {
                "label": "7 days",
                "id": "seven_days",
                "required_plan": null
              },
              {
                "label": "15 days",
                "id": "fifteen_days",
                "required_plan": null
              },
              {
                "label": "30 days",
                "id": "thirty_days",
                "required_plan": null
              },
              {
                "label": "1 year",
                "id": "one_year",
                "required_plan": "enterprise"
              }
            ]
          },
          {
            "label": "in the next",
            "id": "in_the_next",
            "type": "list",
            "items": [
              {
                "label": "7 days",
                "id": "seven_days",
                "required_plan": null
              },
              {
                "label": "15 days",
                "id": "fifteen_days",
                "required_plan": null
              },
              {
                "label": "30 days",
                "id": "thirty_days",
                "required_plan": null
              },
              {
                "label": "1 year",
                "id": "one_year",
                "required_plan": "enterprise"
              }
            ]
          },
          {
            "label": "relative day",
            "id": "equals_relative_date",
            "type": "list",
            "items": [
              {
                "label": "yesterday",
                "id": "yesterday"
              },
              {
                "label": "today",
                "id": "today"
              },
              {
                "label": "tomorrow",
                "id": "tomorrow"
              }
            ]
          }
        ]
      },
      {
        "label": "Entered stage Board Stage 354",
        "id": 1,
        "category": "first_entry_on_stage_date",
        "operators": [
          {
            "label": "in the last",
            "id": "in_the_last",
            "type": "list",
            "items": [
              {
                "label": "7 days",
                "id": "seven_days",
                "required_plan": null
              },
              {
                "label": "15 days",
                "id": "fifteen_days",
                "required_plan": null
              },
              {
                "label": "30 days",
                "id": "thirty_days",
                "required_plan": null
              },
              {
                "label": "1 year",
                "id": "one_year",
                "required_plan": "enterprise"
              }
            ]
          },
          {
            "label": "in the next",
            "id": "in_the_next",
            "type": "list",
            "items": [
              {
                "label": "7 days",
                "id": "seven_days",
                "required_plan": null
              },
              {
                "label": "15 days",
                "id": "fifteen_days",
                "required_plan": null
              },
              {
                "label": "30 days",
                "id": "thirty_days",
                "required_plan": null
              },
              {
                "label": "1 year",
                "id": "one_year",
                "required_plan": "enterprise"
              }
            ]
          },
          {
            "label": "relative day",
            "id": "equals_relative_date",
            "type": "list",
            "items": [
              {
                "label": "yesterday",
                "id": "yesterday"
              },
              {
                "label": "today",
                "id": "today"
              },
              {
                "label": "tomorrow",
                "id": "tomorrow"
              }
            ]
          }
        ]
      },
      {
        "label": "Entered stage Board Stage 355",
        "id": 2,
        "category": "first_entry_on_stage_date",
        "operators": [
          {
            "label": "in the last",
            "id": "in_the_last",
            "type": "list",
            "items": [
              {
                "label": "7 days",
                "id": "seven_days",
                "required_plan": null
              },
              {
                "label": "15 days",
                "id": "fifteen_days",
                "required_plan": null
              },
              {
                "label": "30 days",
                "id": "thirty_days",
                "required_plan": null
              },
              {
                "label": "1 year",
                "id": "one_year",
                "required_plan": "enterprise"
              }
            ]
          },
          {
            "label": "in the next",
            "id": "in_the_next",
            "type": "list",
            "items": [
              {
                "label": "7 days",
                "id": "seven_days",
                "required_plan": null
              },
              {
                "label": "15 days",
                "id": "fifteen_days",
                "required_plan": null
              },
              {
                "label": "30 days",
                "id": "thirty_days",
                "required_plan": null
              },
              {
                "label": "1 year",
                "id": "one_year",
                "required_plan": "enterprise"
              }
            ]
          },
          {
            "label": "relative day",
            "id": "equals_relative_date",
            "type": "list",
            "items": [
              {
                "label": "yesterday",
                "id": "yesterday"
              },
              {
                "label": "today",
                "id": "today"
              },
              {
                "label": "tomorrow",
                "id": "tomorrow"
              }
            ]
          }
        ]
      },
      {
        "label": "Entered stage Board Stage 356",
        "id": 3,
        "category": "first_entry_on_stage_date",
        "operators": [
          {
            "label": "in the last",
            "id": "in_the_last",
            "type": "list",
            "items": [
              {
                "label": "7 days",
                "id": "seven_days",
                "required_plan": null
              },
              {
                "label": "15 days",
                "id": "fifteen_days",
                "required_plan": null
              },
              {
                "label": "30 days",
                "id": "thirty_days",
                "required_plan": null
              },
              {
                "label": "1 year",
                "id": "one_year",
                "required_plan": "enterprise"
              }
            ]
          },
          {
            "label": "in the next",
            "id": "in_the_next",
            "type": "list",
            "items": [
              {
                "label": "7 days",
                "id": "seven_days",
                "required_plan": null
              },
              {
                "label": "15 days",
                "id": "fifteen_days",
                "required_plan": null
              },
              {
                "label": "30 days",
                "id": "thirty_days",
                "required_plan": null
              },
              {
                "label": "1 year",
                "id": "one_year",
                "required_plan": "enterprise"
              }
            ]
          },
          {
            "label": "relative day",
            "id": "equals_relative_date",
            "type": "list",
            "items": [
              {
                "label": "yesterday",
                "id": "yesterday"
              },
              {
                "label": "today",
                "id": "today"
              },
              {
                "label": "tomorrow",
                "id": "tomorrow"
              }
            ]
          }
        ]
      }
    ],
    "period_to_compare_options": [
      {
        "id": "same_days_on_last_period",
        "required_plan": null
      },
      {
        "id": "same_period_on_previous_year",
        "required_plan": "enterprise"
      }
    ],
    "grouping_options": [
      {
        "label": "Client",
        "id": "client",
        "column_types": [
          "client_id",
          "short_text"
        ],
        "details": {
        }
      },
      {
        "label": "Created by",
        "id": "user",
        "column_types": [
          "user_slug",
          "short_text"
        ],
        "details": {
        }
      },
      {
        "label": "Current stage",
        "id": "board_stage",
        "column_types": [
          "short_text"
        ],
        "details": {
        }
      },
      {
        "label": "Delay",
        "id": "overdue",
        "column_types": [
          "overdue"
        ],
        "details": {
          "options": [
            {
              "id": "on_schedule",
              "label": "without delay"
            },
            {
              "id": "soft_overdue",
              "label": "estimated delay"
            },
            {
              "id": "hard_overdue",
              "label": "with delay"
            }
          ]
        }
      },
      {
        "label": "Expected time (SLA) exceeded",
        "id": "is_board_stage_sla_elapsed_time_overdue",
        "column_types": [
          "boolean"
        ],
        "details": {
        }
      },
      {
        "label": "Inactivity timeout exceeded",
        "id": "is_board_stage_sla_last_activity_time_overdue",
        "column_types": [
          "boolean"
        ],
        "details": {
        }
      },
      {
        "label": "Project",
        "id": "project",
        "column_types": [
          "project_id",
          "short_text"
        ],
        "details": {
        }
      },
      {
        "label": "Shared",
        "id": "is_shared",
        "column_types": [
          "boolean"
        ],
        "details": {
        }
      },
      {
        "label": "State",
        "id": "state",
        "column_types": [
          "task_state"
        ],
        "details": {
          "options": [
            {
              "id": "closed",
              "label": "completed"
            },
            {
              "id": "queued",
              "label": "pending"
            },
            {
              "id": "working_on",
              "label": "in development"
            },
            {
              "id": "not_assigned",
              "label": "unassigned"
            }
          ]
        }
      },
      {
        "label": "Tags",
        "id": "tags",
        "column_types": [
          "tags"
        ],
        "details": {
        }
      },
      {
        "label": "Teams assigned",
        "id": "teams",
        "column_types": [
          "team_ids"
        ],
        "details": {
        }
      },
      {
        "label": "Type",
        "id": "task_type",
        "column_types": [
          "type_id",
          "short_text"
        ],
        "details": {
        }
      },
      {
        "label": "Urgent",
        "id": "is_urgent",
        "column_types": [
          "boolean"
        ],
        "details": {
        }
      },
      {
        "label": "Users assigned",
        "id": "assignees",
        "column_types": [
          "user_slugs"
        ],
        "details": {
        }
      }
    ]
  }
]

GET

/api/v1.0/dashboards/:dashboard_id/widgets/form_setup

Add fields of boards when type is numeric or rating

Request

Route

GET /api/v1.0/dashboards/1/widgets/form_setup

Headers

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

cURL

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

Response

Simulated Response

Status

Headers

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

Body

[
  {
    "id": "tasks",
    "column_id": "id",
    "field_type": "tasks",
    "category": "recommended",
    "label": "Tasks",
    "description": "Number of tasks on this board",
    "is_available": true,
    "preview_url": "/api/dashboards/1/widgets/tasks",
    "functions": [
      "count"
    ],
    "horizontal_options": [
      {
        "label": "Client",
        "id": "client",
        "column_types": [
          "client_id",
          "short_text"
        ],
        "details": {
        }
      },
      {
        "label": "Created by",
        "id": "user",
        "column_types": [
          "user_slug",
          "short_text"
        ],
        "details": {
        }
      },
      {
        "label": "Creation date",
        "id": "created_at",
        "column_types": [
          "datetime"
        ],
        "details": {
        }
      },
      {
        "label": "Current stage",
        "id": "board_stage",
        "column_types": [
          "short_text"
        ],
        "details": {
        }
      },
      {
        "label": "Delay",
        "id": "overdue",
        "column_types": [
          "overdue"
        ],
        "details": {
          "options": [
            {
              "id": "on_schedule",
              "label": "without delay"
            },
            {
              "id": "soft_overdue",
              "label": "estimated delay"
            },
            {
              "id": "hard_overdue",
              "label": "with delay"
            }
          ]
        }
      },
      {
        "label": "Delivery date",
        "id": "close_date",
        "column_types": [
          "datetime"
        ],
        "details": {
        }
      },
      {
        "label": "Desired delivery date",
        "id": "desired_date",
        "column_types": [
          "datetime"
        ],
        "details": {
        }
      },
      {
        "label": "Desired start date",
        "id": "desired_start_date",
        "column_types": [
          "datetime"
        ],
        "details": {
        }
      },
      {
        "label": "Estimated delivery date",
        "id": "estimated_delivery_date",
        "column_types": [
          "datetime"
        ],
        "details": {
        }
      },
      {
        "label": "Expected time (SLA) exceeded",
        "id": "is_board_stage_sla_elapsed_time_overdue",
        "column_types": [
          "boolean"
        ],
        "details": {
        }
      },
      {
        "label": "Inactivity timeout exceeded",
        "id": "is_board_stage_sla_last_activity_time_overdue",
        "column_types": [
          "boolean"
        ],
        "details": {
        }
      },
      {
        "label": "Numeric Field",
        "id": "custom_1",
        "column_types": [
          "numeric"
        ],
        "details": {
        }
      },
      {
        "label": "Project",
        "id": "project",
        "column_types": [
          "project_id",
          "short_text"
        ],
        "details": {
        }
      },
      {
        "label": "Shared",
        "id": "is_shared",
        "column_types": [
          "boolean"
        ],
        "details": {
        }
      },
      {
        "label": "Start date",
        "id": "start_date",
        "column_types": [
          "datetime"
        ],
        "details": {
        }
      },
      {
        "label": "State",
        "id": "state",
        "column_types": [
          "task_state"
        ],
        "details": {
          "options": [
            {
              "id": "closed",
              "label": "completed"
            },
            {
              "id": "queued",
              "label": "pending"
            },
            {
              "id": "working_on",
              "label": "in development"
            },
            {
              "id": "not_assigned",
              "label": "unassigned"
            }
          ]
        }
      },
      {
        "label": "Tags",
        "id": "tags",
        "column_types": [
          "tags"
        ],
        "details": {
        }
      },
      {
        "label": "Teams assigned",
        "id": "teams",
        "column_types": [
          "team_ids"
        ],
        "details": {
        }
      },
      {
        "label": "Type",
        "id": "task_type",
        "column_types": [
          "type_id",
          "short_text"
        ],
        "details": {
        }
      },
      {
        "label": "Urgent",
        "id": "is_urgent",
        "column_types": [
          "boolean"
        ],
        "details": {
        }
      },
      {
        "label": "Users assigned",
        "id": "assignees",
        "column_types": [
          "user_slugs"
        ],
        "details": {
        }
      }
    ],
    "period_to_analyze_options": [
      {
        "label": "From the beginning",
        "id": null,
        "required_plan": "enterprise"
      },
      {
        "label": "Creation date",
        "id": "created_at",
        "operators": [
          {
            "label": "in the last",
            "id": "in_the_last",
            "type": "list",
            "items": [
              {
                "label": "7 days",
                "id": "seven_days",
                "required_plan": null
              },
              {
                "label": "15 days",
                "id": "fifteen_days",
                "required_plan": null
              },
              {
                "label": "30 days",
                "id": "thirty_days",
                "required_plan": null
              },
              {
                "label": "1 year",
                "id": "one_year",
                "required_plan": "enterprise"
              }
            ]
          },
          {
            "label": "in the next",
            "id": "in_the_next",
            "type": "list",
            "items": [
              {
                "label": "7 days",
                "id": "seven_days",
                "required_plan": null
              },
              {
                "label": "15 days",
                "id": "fifteen_days",
                "required_plan": null
              },
              {
                "label": "30 days",
                "id": "thirty_days",
                "required_plan": null
              },
              {
                "label": "1 year",
                "id": "one_year",
                "required_plan": "enterprise"
              }
            ]
          },
          {
            "label": "relative day",
            "id": "equals_relative_date",
            "type": "list",
            "items": [
              {
                "label": "yesterday",
                "id": "yesterday"
              },
              {
                "label": "today",
                "id": "today"
              },
              {
                "label": "tomorrow",
                "id": "tomorrow"
              }
            ]
          }
        ]
      },
      {
        "label": "Delivery date",
        "id": "close_date",
        "operators": [
          {
            "label": "in the last",
            "id": "in_the_last",
            "type": "list",
            "items": [
              {
                "label": "7 days",
                "id": "seven_days",
                "required_plan": null
              },
              {
                "label": "15 days",
                "id": "fifteen_days",
                "required_plan": null
              },
              {
                "label": "30 days",
                "id": "thirty_days",
                "required_plan": null
              },
              {
                "label": "1 year",
                "id": "one_year",
                "required_plan": "enterprise"
              }
            ]
          },
          {
            "label": "in the next",
            "id": "in_the_next",
            "type": "list",
            "items": [
              {
                "label": "7 days",
                "id": "seven_days",
                "required_plan": null
              },
              {
                "label": "15 days",
                "id": "fifteen_days",
                "required_plan": null
              },
              {
                "label": "30 days",
                "id": "thirty_days",
                "required_plan": null
              },
              {
                "label": "1 year",
                "id": "one_year",
                "required_plan": "enterprise"
              }
            ]
          },
          {
            "label": "relative day",
            "id": "equals_relative_date",
            "type": "list",
            "items": [
              {
                "label": "yesterday",
                "id": "yesterday"
              },
              {
                "label": "today",
                "id": "today"
              },
              {
                "label": "tomorrow",
                "id": "tomorrow"
              }
            ]
          }
        ]
      },
      {
        "label": "Desired delivery date",
        "id": "desired_date",
        "operators": [
          {
            "label": "in the last",
            "id": "in_the_last",
            "type": "list",
            "items": [
              {
                "label": "7 days",
                "id": "seven_days",
                "required_plan": null
              },
              {
                "label": "15 days",
                "id": "fifteen_days",
                "required_plan": null
              },
              {
                "label": "30 days",
                "id": "thirty_days",
                "required_plan": null
              },
              {
                "label": "1 year",
                "id": "one_year",
                "required_plan": "enterprise"
              }
            ]
          },
          {
            "label": "in the next",
            "id": "in_the_next",
            "type": "list",
            "items": [
              {
                "label": "7 days",
                "id": "seven_days",
                "required_plan": null
              },
              {
                "label": "15 days",
                "id": "fifteen_days",
                "required_plan": null
              },
              {
                "label": "30 days",
                "id": "thirty_days",
                "required_plan": null
              },
              {
                "label": "1 year",
                "id": "one_year",
                "required_plan": "enterprise"
              }
            ]
          },
          {
            "label": "relative day",
            "id": "equals_relative_date",
            "type": "list",
            "items": [
              {
                "label": "yesterday",
                "id": "yesterday"
              },
              {
                "label": "today",
                "id": "today"
              },
              {
                "label": "tomorrow",
                "id": "tomorrow"
              }
            ]
          }
        ]
      },
      {
        "label": "Desired start date",
        "id": "desired_start_date",
        "operators": [
          {
            "label": "in the last",
            "id": "in_the_last",
            "type": "list",
            "items": [
              {
                "label": "7 days",
                "id": "seven_days",
                "required_plan": null
              },
              {
                "label": "15 days",
                "id": "fifteen_days",
                "required_plan": null
              },
              {
                "label": "30 days",
                "id": "thirty_days",
                "required_plan": null
              },
              {
                "label": "1 year",
                "id": "one_year",
                "required_plan": "enterprise"
              }
            ]
          },
          {
            "label": "in the next",
            "id": "in_the_next",
            "type": "list",
            "items": [
              {
                "label": "7 days",
                "id": "seven_days",
                "required_plan": null
              },
              {
                "label": "15 days",
                "id": "fifteen_days",
                "required_plan": null
              },
              {
                "label": "30 days",
                "id": "thirty_days",
                "required_plan": null
              },
              {
                "label": "1 year",
                "id": "one_year",
                "required_plan": "enterprise"
              }
            ]
          },
          {
            "label": "relative day",
            "id": "equals_relative_date",
            "type": "list",
            "items": [
              {
                "label": "yesterday",
                "id": "yesterday"
              },
              {
                "label": "today",
                "id": "today"
              },
              {
                "label": "tomorrow",
                "id": "tomorrow"
              }
            ]
          }
        ]
      },
      {
        "label": "Estimated delivery date",
        "id": "estimated_delivery_date",
        "operators": [
          {
            "label": "in the last",
            "id": "in_the_last",
            "type": "list",
            "items": [
              {
                "label": "7 days",
                "id": "seven_days",
                "required_plan": null
              },
              {
                "label": "15 days",
                "id": "fifteen_days",
                "required_plan": null
              },
              {
                "label": "30 days",
                "id": "thirty_days",
                "required_plan": null
              },
              {
                "label": "1 year",
                "id": "one_year",
                "required_plan": "enterprise"
              }
            ]
          },
          {
            "label": "in the next",
            "id": "in_the_next",
            "type": "list",
            "items": [
              {
                "label": "7 days",
                "id": "seven_days",
                "required_plan": null
              },
              {
                "label": "15 days",
                "id": "fifteen_days",
                "required_plan": null
              },
              {
                "label": "30 days",
                "id": "thirty_days",
                "required_plan": null
              },
              {
                "label": "1 year",
                "id": "one_year",
                "required_plan": "enterprise"
              }
            ]
          },
          {
            "label": "relative day",
            "id": "equals_relative_date",
            "type": "list",
            "items": [
              {
                "label": "yesterday",
                "id": "yesterday"
              },
              {
                "label": "today",
                "id": "today"
              },
              {
                "label": "tomorrow",
                "id": "tomorrow"
              }
            ]
          }
        ]
      },
      {
        "label": "Last update",
        "id": "last_activity_at",
        "operators": [
          {
            "label": "in the last",
            "id": "in_the_last",
            "type": "list",
            "items": [
              {
                "label": "7 days",
                "id": "seven_days",
                "required_plan": null
              },
              {
                "label": "15 days",
                "id": "fifteen_days",
                "required_plan": null
              },
              {
                "label": "30 days",
                "id": "thirty_days",
                "required_plan": null
              },
              {
                "label": "1 year",
                "id": "one_year",
                "required_plan": "enterprise"
              }
            ]
          },
          {
            "label": "in the next",
            "id": "in_the_next",
            "type": "list",
            "items": [
              {
                "label": "7 days",
                "id": "seven_days",
                "required_plan": null
              },
              {
                "label": "15 days",
                "id": "fifteen_days",
                "required_plan": null
              },
              {
                "label": "30 days",
                "id": "thirty_days",
                "required_plan": null
              },
              {
                "label": "1 year",
                "id": "one_year",
                "required_plan": "enterprise"
              }
            ]
          },
          {
            "label": "relative day",
            "id": "equals_relative_date",
            "type": "list",
            "items": [
              {
                "label": "yesterday",
                "id": "yesterday"
              },
              {
                "label": "today",
                "id": "today"
              },
              {
                "label": "tomorrow",
                "id": "tomorrow"
              }
            ]
          }
        ]
      },
      {
        "label": "Start date",
        "id": "start_date",
        "operators": [
          {
            "label": "in the last",
            "id": "in_the_last",
            "type": "list",
            "items": [
              {
                "label": "7 days",
                "id": "seven_days",
                "required_plan": null
              },
              {
                "label": "15 days",
                "id": "fifteen_days",
                "required_plan": null
              },
              {
                "label": "30 days",
                "id": "thirty_days",
                "required_plan": null
              },
              {
                "label": "1 year",
                "id": "one_year",
                "required_plan": "enterprise"
              }
            ]
          },
          {
            "label": "in the next",
            "id": "in_the_next",
            "type": "list",
            "items": [
              {
                "label": "7 days",
                "id": "seven_days",
                "required_plan": null
              },
              {
                "label": "15 days",
                "id": "fifteen_days",
                "required_plan": null
              },
              {
                "label": "30 days",
                "id": "thirty_days",
                "required_plan": null
              },
              {
                "label": "1 year",
                "id": "one_year",
                "required_plan": "enterprise"
              }
            ]
          },
          {
            "label": "relative day",
            "id": "equals_relative_date",
            "type": "list",
            "items": [
              {
                "label": "yesterday",
                "id": "yesterday"
              },
              {
                "label": "today",
                "id": "today"
              },
              {
                "label": "tomorrow",
                "id": "tomorrow"
              }
            ]
          }
        ]
      }
    ],
    "period_to_compare_options": [
      {
        "id": "same_days_on_last_period",
        "required_plan": null
      },
      {
        "id": "same_period_on_previous_year",
        "required_plan": "enterprise"
      }
    ],
    "grouping_options": [
      {
        "label": "Client",
        "id": "client",
        "column_types": [
          "client_id",
          "short_text"
        ],
        "details": {
        }
      },
      {
        "label": "Created by",
        "id": "user",
        "column_types": [
          "user_slug",
          "short_text"
        ],
        "details": {
        }
      },
      {
        "label": "Current stage",
        "id": "board_stage",
        "column_types": [
          "short_text"
        ],
        "details": {
        }
      },
      {
        "label": "Delay",
        "id": "overdue",
        "column_types": [
          "overdue"
        ],
        "details": {
          "options": [
            {
              "id": "on_schedule",
              "label": "without delay"
            },
            {
              "id": "soft_overdue",
              "label": "estimated delay"
            },
            {
              "id": "hard_overdue",
              "label": "with delay"
            }
          ]
        }
      },
      {
        "label": "Expected time (SLA) exceeded",
        "id": "is_board_stage_sla_elapsed_time_overdue",
        "column_types": [
          "boolean"
        ],
        "details": {
        }
      },
      {
        "label": "Inactivity timeout exceeded",
        "id": "is_board_stage_sla_last_activity_time_overdue",
        "column_types": [
          "boolean"
        ],
        "details": {
        }
      },
      {
        "label": "Numeric Field",
        "id": "custom_1",
        "column_types": [
          "numeric"
        ],
        "details": {
        }
      },
      {
        "label": "Project",
        "id": "project",
        "column_types": [
          "project_id",
          "short_text"
        ],
        "details": {
        }
      },
      {
        "label": "Shared",
        "id": "is_shared",
        "column_types": [
          "boolean"
        ],
        "details": {
        }
      },
      {
        "label": "State",
        "id": "state",
        "column_types": [
          "task_state"
        ],
        "details": {
          "options": [
            {
              "id": "closed",
              "label": "completed"
            },
            {
              "id": "queued",
              "label": "pending"
            },
            {
              "id": "working_on",
              "label": "in development"
            },
            {
              "id": "not_assigned",
              "label": "unassigned"
            }
          ]
        }
      },
      {
        "label": "Tags",
        "id": "tags",
        "column_types": [
          "tags"
        ],
        "details": {
        }
      },
      {
        "label": "Teams assigned",
        "id": "teams",
        "column_types": [
          "team_ids"
        ],
        "details": {
        }
      },
      {
        "label": "Type",
        "id": "task_type",
        "column_types": [
          "type_id",
          "short_text"
        ],
        "details": {
        }
      },
      {
        "label": "Urgent",
        "id": "is_urgent",
        "column_types": [
          "boolean"
        ],
        "details": {
        }
      },
      {
        "label": "Users assigned",
        "id": "assignees",
        "column_types": [
          "user_slugs"
        ],
        "details": {
        }
      }
    ]
  },
  {
    "id": "task_trackings",
    "column_id": "task_trackings",
    "field_type": "time_trackings",
    "category": "recommended",
    "label": "Elapsed time",
    "description": "Time in the open stages",
    "is_available": true,
    "preview_url": "/api/dashboards/1/widgets/task_trackings",
    "functions": [
      "sum",
      "avg",
      "max",
      "min"
    ],
    "horizontal_options": [
      {
        "label": "Client",
        "id": "client",
        "column_types": [
          "client_id",
          "short_text"
        ],
        "details": {
        }
      },
      {
        "label": "Created by",
        "id": "user",
        "column_types": [
          "user_slug",
          "short_text"
        ],
        "details": {
        }
      },
      {
        "label": "Creation date",
        "id": "created_at",
        "column_types": [
          "datetime"
        ],
        "details": {
        }
      },
      {
        "label": "Current stage",
        "id": "board_stage",
        "column_types": [
          "short_text"
        ],
        "details": {
        }
      },
      {
        "label": "Delay",
        "id": "overdue",
        "column_types": [
          "overdue"
        ],
        "details": {
          "options": [
            {
              "id": "on_schedule",
              "label": "without delay"
            },
            {
              "id": "soft_overdue",
              "label": "estimated delay"
            },
            {
              "id": "hard_overdue",
              "label": "with delay"
            }
          ]
        }
      },
      {
        "label": "Delivery date",
        "id": "close_date",
        "column_types": [
          "datetime"
        ],
        "details": {
        }
      },
      {
        "label": "Desired delivery date",
        "id": "desired_date",
        "column_types": [
          "datetime"
        ],
        "details": {
        }
      },
      {
        "label": "Desired start date",
        "id": "desired_start_date",
        "column_types": [
          "datetime"
        ],
        "details": {
        }
      },
      {
        "label": "Estimated delivery date",
        "id": "estimated_delivery_date",
        "column_types": [
          "datetime"
        ],
        "details": {
        }
      },
      {
        "label": "Expected time (SLA) exceeded",
        "id": "is_board_stage_sla_elapsed_time_overdue",
        "column_types": [
          "boolean"
        ],
        "details": {
        }
      },
      {
        "label": "Inactivity timeout exceeded",
        "id": "is_board_stage_sla_last_activity_time_overdue",
        "column_types": [
          "boolean"
        ],
        "details": {
        }
      },
      {
        "label": "Numeric Field",
        "id": "custom_1",
        "column_types": [
          "numeric"
        ],
        "details": {
        }
      },
      {
        "label": "Project",
        "id": "project",
        "column_types": [
          "project_id",
          "short_text"
        ],
        "details": {
        }
      },
      {
        "label": "Shared",
        "id": "is_shared",
        "column_types": [
          "boolean"
        ],
        "details": {
        }
      },
      {
        "label": "Start date",
        "id": "start_date",
        "column_types": [
          "datetime"
        ],
        "details": {
        }
      },
      {
        "label": "State",
        "id": "state",
        "column_types": [
          "task_state"
        ],
        "details": {
          "options": [
            {
              "id": "closed",
              "label": "completed"
            },
            {
              "id": "queued",
              "label": "pending"
            },
            {
              "id": "working_on",
              "label": "in development"
            },
            {
              "id": "not_assigned",
              "label": "unassigned"
            }
          ]
        }
      },
      {
        "label": "Tags",
        "id": "tags",
        "column_types": [
          "tags"
        ],
        "details": {
        }
      },
      {
        "label": "Teams assigned",
        "id": "teams",
        "column_types": [
          "team_ids"
        ],
        "details": {
        }
      },
      {
        "label": "Type",
        "id": "task_type",
        "column_types": [
          "type_id",
          "short_text"
        ],
        "details": {
        }
      },
      {
        "label": "Urgent",
        "id": "is_urgent",
        "column_types": [
          "boolean"
        ],
        "details": {
        }
      },
      {
        "label": "Users assigned",
        "id": "assignees",
        "column_types": [
          "user_slugs"
        ],
        "details": {
        }
      }
    ],
    "period_to_analyze_options": [
      {
        "label": "From the beginning",
        "id": null,
        "required_plan": "enterprise"
      },
      {
        "label": "Delivery date",
        "id": "close_date",
        "operators": [
          {
            "label": "in the last",
            "id": "in_the_last",
            "type": "list",
            "items": [
              {
                "label": "7 days",
                "id": "seven_days",
                "required_plan": null
              },
              {
                "label": "15 days",
                "id": "fifteen_days",
                "required_plan": null
              },
              {
                "label": "30 days",
                "id": "thirty_days",
                "required_plan": null
              },
              {
                "label": "1 year",
                "id": "one_year",
                "required_plan": "enterprise"
              }
            ]
          },
          {
            "label": "in the next",
            "id": "in_the_next",
            "type": "list",
            "items": [
              {
                "label": "7 days",
                "id": "seven_days",
                "required_plan": null
              },
              {
                "label": "15 days",
                "id": "fifteen_days",
                "required_plan": null
              },
              {
                "label": "30 days",
                "id": "thirty_days",
                "required_plan": null
              },
              {
                "label": "1 year",
                "id": "one_year",
                "required_plan": "enterprise"
              }
            ]
          },
          {
            "label": "relative day",
            "id": "equals_relative_date",
            "type": "list",
            "items": [
              {
                "label": "yesterday",
                "id": "yesterday"
              },
              {
                "label": "today",
                "id": "today"
              },
              {
                "label": "tomorrow",
                "id": "tomorrow"
              }
            ]
          }
        ]
      },
      {
        "label": "Entered stage Board Stage 357",
        "id": 1,
        "category": "first_entry_on_stage_date",
        "operators": [
          {
            "label": "in the last",
            "id": "in_the_last",
            "type": "list",
            "items": [
              {
                "label": "7 days",
                "id": "seven_days",
                "required_plan": null
              },
              {
                "label": "15 days",
                "id": "fifteen_days",
                "required_plan": null
              },
              {
                "label": "30 days",
                "id": "thirty_days",
                "required_plan": null
              },
              {
                "label": "1 year",
                "id": "one_year",
                "required_plan": "enterprise"
              }
            ]
          },
          {
            "label": "in the next",
            "id": "in_the_next",
            "type": "list",
            "items": [
              {
                "label": "7 days",
                "id": "seven_days",
                "required_plan": null
              },
              {
                "label": "15 days",
                "id": "fifteen_days",
                "required_plan": null
              },
              {
                "label": "30 days",
                "id": "thirty_days",
                "required_plan": null
              },
              {
                "label": "1 year",
                "id": "one_year",
                "required_plan": "enterprise"
              }
            ]
          },
          {
            "label": "relative day",
            "id": "equals_relative_date",
            "type": "list",
            "items": [
              {
                "label": "yesterday",
                "id": "yesterday"
              },
              {
                "label": "today",
                "id": "today"
              },
              {
                "label": "tomorrow",
                "id": "tomorrow"
              }
            ]
          }
        ]
      },
      {
        "label": "Entered stage Board Stage 358",
        "id": 2,
        "category": "first_entry_on_stage_date",
        "operators": [
          {
            "label": "in the last",
            "id": "in_the_last",
            "type": "list",
            "items": [
              {
                "label": "7 days",
                "id": "seven_days",
                "required_plan": null
              },
              {
                "label": "15 days",
                "id": "fifteen_days",
                "required_plan": null
              },
              {
                "label": "30 days",
                "id": "thirty_days",
                "required_plan": null
              },
              {
                "label": "1 year",
                "id": "one_year",
                "required_plan": "enterprise"
              }
            ]
          },
          {
            "label": "in the next",
            "id": "in_the_next",
            "type": "list",
            "items": [
              {
                "label": "7 days",
                "id": "seven_days",
                "required_plan": null
              },
              {
                "label": "15 days",
                "id": "fifteen_days",
                "required_plan": null
              },
              {
                "label": "30 days",
                "id": "thirty_days",
                "required_plan": null
              },
              {
                "label": "1 year",
                "id": "one_year",
                "required_plan": "enterprise"
              }
            ]
          },
          {
            "label": "relative day",
            "id": "equals_relative_date",
            "type": "list",
            "items": [
              {
                "label": "yesterday",
                "id": "yesterday"
              },
              {
                "label": "today",
                "id": "today"
              },
              {
                "label": "tomorrow",
                "id": "tomorrow"
              }
            ]
          }
        ]
      },
      {
        "label": "Entered stage Board Stage 359",
        "id": 3,
        "category": "first_entry_on_stage_date",
        "operators": [
          {
            "label": "in the last",
            "id": "in_the_last",
            "type": "list",
            "items": [
              {
                "label": "7 days",
                "id": "seven_days",
                "required_plan": null
              },
              {
                "label": "15 days",
                "id": "fifteen_days",
                "required_plan": null
              },
              {
                "label": "30 days",
                "id": "thirty_days",
                "required_plan": null
              },
              {
                "label": "1 year",
                "id": "one_year",
                "required_plan": "enterprise"
              }
            ]
          },
          {
            "label": "in the next",
            "id": "in_the_next",
            "type": "list",
            "items": [
              {
                "label": "7 days",
                "id": "seven_days",
                "required_plan": null
              },
              {
                "label": "15 days",
                "id": "fifteen_days",
                "required_plan": null
              },
              {
                "label": "30 days",
                "id": "thirty_days",
                "required_plan": null
              },
              {
                "label": "1 year",
                "id": "one_year",
                "required_plan": "enterprise"
              }
            ]
          },
          {
            "label": "relative day",
            "id": "equals_relative_date",
            "type": "list",
            "items": [
              {
                "label": "yesterday",
                "id": "yesterday"
              },
              {
                "label": "today",
                "id": "today"
              },
              {
                "label": "tomorrow",
                "id": "tomorrow"
              }
            ]
          }
        ]
      }
    ],
    "period_to_compare_options": [
      {
        "id": "same_days_on_last_period",
        "required_plan": null
      },
      {
        "id": "same_period_on_previous_year",
        "required_plan": "enterprise"
      }
    ],
    "grouping_options": [
      {
        "label": "Client",
        "id": "client",
        "column_types": [
          "client_id",
          "short_text"
        ],
        "details": {
        }
      },
      {
        "label": "Created by",
        "id": "user",
        "column_types": [
          "user_slug",
          "short_text"
        ],
        "details": {
        }
      },
      {
        "label": "Current stage",
        "id": "board_stage",
        "column_types": [
          "short_text"
        ],
        "details": {
        }
      },
      {
        "label": "Delay",
        "id": "overdue",
        "column_types": [
          "overdue"
        ],
        "details": {
          "options": [
            {
              "id": "on_schedule",
              "label": "without delay"
            },
            {
              "id": "soft_overdue",
              "label": "estimated delay"
            },
            {
              "id": "hard_overdue",
              "label": "with delay"
            }
          ]
        }
      },
      {
        "label": "Expected time (SLA) exceeded",
        "id": "is_board_stage_sla_elapsed_time_overdue",
        "column_types": [
          "boolean"
        ],
        "details": {
        }
      },
      {
        "label": "Inactivity timeout exceeded",
        "id": "is_board_stage_sla_last_activity_time_overdue",
        "column_types": [
          "boolean"
        ],
        "details": {
        }
      },
      {
        "label": "Numeric Field",
        "id": "custom_1",
        "column_types": [
          "numeric"
        ],
        "details": {
        }
      },
      {
        "label": "Project",
        "id": "project",
        "column_types": [
          "project_id",
          "short_text"
        ],
        "details": {
        }
      },
      {
        "label": "Shared",
        "id": "is_shared",
        "column_types": [
          "boolean"
        ],
        "details": {
        }
      },
      {
        "label": "State",
        "id": "state",
        "column_types": [
          "task_state"
        ],
        "details": {
          "options": [
            {
              "id": "closed",
              "label": "completed"
            },
            {
              "id": "queued",
              "label": "pending"
            },
            {
              "id": "working_on",
              "label": "in development"
            },
            {
              "id": "not_assigned",
              "label": "unassigned"
            }
          ]
        }
      },
      {
        "label": "Tags",
        "id": "tags",
        "column_types": [
          "tags"
        ],
        "details": {
        }
      },
      {
        "label": "Teams assigned",
        "id": "teams",
        "column_types": [
          "team_ids"
        ],
        "details": {
        }
      },
      {
        "label": "Type",
        "id": "task_type",
        "column_types": [
          "type_id",
          "short_text"
        ],
        "details": {
        }
      },
      {
        "label": "Urgent",
        "id": "is_urgent",
        "column_types": [
          "boolean"
        ],
        "details": {
        }
      },
      {
        "label": "Users assigned",
        "id": "assignees",
        "column_types": [
          "user_slugs"
        ],
        "details": {
        }
      }
    ]
  },
  {
    "id": "custom_1",
    "column_id": "custom_1",
    "field_type": "numeric",
    "category": "custom",
    "label": "Numeric Field",
    "is_available": true,
    "preview_url": "/api/dashboards/1/widgets/tasks",
    "functions": [
      "sum",
      "avg",
      "max",
      "min"
    ],
    "horizontal_options": [
      {
        "label": "Client",
        "id": "client",
        "column_types": [
          "client_id",
          "short_text"
        ],
        "details": {
        }
      },
      {
        "label": "Created by",
        "id": "user",
        "column_types": [
          "user_slug",
          "short_text"
        ],
        "details": {
        }
      },
      {
        "label": "Creation date",
        "id": "created_at",
        "column_types": [
          "datetime"
        ],
        "details": {
        }
      },
      {
        "label": "Current stage",
        "id": "board_stage",
        "column_types": [
          "short_text"
        ],
        "details": {
        }
      },
      {
        "label": "Delay",
        "id": "overdue",
        "column_types": [
          "overdue"
        ],
        "details": {
          "options": [
            {
              "id": "on_schedule",
              "label": "without delay"
            },
            {
              "id": "soft_overdue",
              "label": "estimated delay"
            },
            {
              "id": "hard_overdue",
              "label": "with delay"
            }
          ]
        }
      },
      {
        "label": "Delivery date",
        "id": "close_date",
        "column_types": [
          "datetime"
        ],
        "details": {
        }
      },
      {
        "label": "Desired delivery date",
        "id": "desired_date",
        "column_types": [
          "datetime"
        ],
        "details": {
        }
      },
      {
        "label": "Desired start date",
        "id": "desired_start_date",
        "column_types": [
          "datetime"
        ],
        "details": {
        }
      },
      {
        "label": "Estimated delivery date",
        "id": "estimated_delivery_date",
        "column_types": [
          "datetime"
        ],
        "details": {
        }
      },
      {
        "label": "Expected time (SLA) exceeded",
        "id": "is_board_stage_sla_elapsed_time_overdue",
        "column_types": [
          "boolean"
        ],
        "details": {
        }
      },
      {
        "label": "Inactivity timeout exceeded",
        "id": "is_board_stage_sla_last_activity_time_overdue",
        "column_types": [
          "boolean"
        ],
        "details": {
        }
      },
      {
        "label": "Project",
        "id": "project",
        "column_types": [
          "project_id",
          "short_text"
        ],
        "details": {
        }
      },
      {
        "label": "Shared",
        "id": "is_shared",
        "column_types": [
          "boolean"
        ],
        "details": {
        }
      },
      {
        "label": "Start date",
        "id": "start_date",
        "column_types": [
          "datetime"
        ],
        "details": {
        }
      },
      {
        "label": "State",
        "id": "state",
        "column_types": [
          "task_state"
        ],
        "details": {
          "options": [
            {
              "id": "closed",
              "label": "completed"
            },
            {
              "id": "queued",
              "label": "pending"
            },
            {
              "id": "working_on",
              "label": "in development"
            },
            {
              "id": "not_assigned",
              "label": "unassigned"
            }
          ]
        }
      },
      {
        "label": "Tags",
        "id": "tags",
        "column_types": [
          "tags"
        ],
        "details": {
        }
      },
      {
        "label": "Teams assigned",
        "id": "teams",
        "column_types": [
          "team_ids"
        ],
        "details": {
        }
      },
      {
        "label": "Type",
        "id": "task_type",
        "column_types": [
          "type_id",
          "short_text"
        ],
        "details": {
        }
      },
      {
        "label": "Urgent",
        "id": "is_urgent",
        "column_types": [
          "boolean"
        ],
        "details": {
        }
      },
      {
        "label": "Users assigned",
        "id": "assignees",
        "column_types": [
          "user_slugs"
        ],
        "details": {
        }
      }
    ],
    "period_to_analyze_options": [
      {
        "label": "From the beginning",
        "id": null,
        "required_plan": "enterprise"
      },
      {
        "label": "Creation date",
        "id": "created_at",
        "operators": [
          {
            "label": "in the last",
            "id": "in_the_last",
            "type": "list",
            "items": [
              {
                "label": "7 days",
                "id": "seven_days",
                "required_plan": null
              },
              {
                "label": "15 days",
                "id": "fifteen_days",
                "required_plan": null
              },
              {
                "label": "30 days",
                "id": "thirty_days",
                "required_plan": null
              },
              {
                "label": "1 year",
                "id": "one_year",
                "required_plan": "enterprise"
              }
            ]
          },
          {
            "label": "in the next",
            "id": "in_the_next",
            "type": "list",
            "items": [
              {
                "label": "7 days",
                "id": "seven_days",
                "required_plan": null
              },
              {
                "label": "15 days",
                "id": "fifteen_days",
                "required_plan": null
              },
              {
                "label": "30 days",
                "id": "thirty_days",
                "required_plan": null
              },
              {
                "label": "1 year",
                "id": "one_year",
                "required_plan": "enterprise"
              }
            ]
          },
          {
            "label": "relative day",
            "id": "equals_relative_date",
            "type": "list",
            "items": [
              {
                "label": "yesterday",
                "id": "yesterday"
              },
              {
                "label": "today",
                "id": "today"
              },
              {
                "label": "tomorrow",
                "id": "tomorrow"
              }
            ]
          }
        ]
      },
      {
        "label": "Delivery date",
        "id": "close_date",
        "operators": [
          {
            "label": "in the last",
            "id": "in_the_last",
            "type": "list",
            "items": [
              {
                "label": "7 days",
                "id": "seven_days",
                "required_plan": null
              },
              {
                "label": "15 days",
                "id": "fifteen_days",
                "required_plan": null
              },
              {
                "label": "30 days",
                "id": "thirty_days",
                "required_plan": null
              },
              {
                "label": "1 year",
                "id": "one_year",
                "required_plan": "enterprise"
              }
            ]
          },
          {
            "label": "in the next",
            "id": "in_the_next",
            "type": "list",
            "items": [
              {
                "label": "7 days",
                "id": "seven_days",
                "required_plan": null
              },
              {
                "label": "15 days",
                "id": "fifteen_days",
                "required_plan": null
              },
              {
                "label": "30 days",
                "id": "thirty_days",
                "required_plan": null
              },
              {
                "label": "1 year",
                "id": "one_year",
                "required_plan": "enterprise"
              }
            ]
          },
          {
            "label": "relative day",
            "id": "equals_relative_date",
            "type": "list",
            "items": [
              {
                "label": "yesterday",
                "id": "yesterday"
              },
              {
                "label": "today",
                "id": "today"
              },
              {
                "label": "tomorrow",
                "id": "tomorrow"
              }
            ]
          }
        ]
      },
      {
        "label": "Desired delivery date",
        "id": "desired_date",
        "operators": [
          {
            "label": "in the last",
            "id": "in_the_last",
            "type": "list",
            "items": [
              {
                "label": "7 days",
                "id": "seven_days",
                "required_plan": null
              },
              {
                "label": "15 days",
                "id": "fifteen_days",
                "required_plan": null
              },
              {
                "label": "30 days",
                "id": "thirty_days",
                "required_plan": null
              },
              {
                "label": "1 year",
                "id": "one_year",
                "required_plan": "enterprise"
              }
            ]
          },
          {
            "label": "in the next",
            "id": "in_the_next",
            "type": "list",
            "items": [
              {
                "label": "7 days",
                "id": "seven_days",
                "required_plan": null
              },
              {
                "label": "15 days",
                "id": "fifteen_days",
                "required_plan": null
              },
              {
                "label": "30 days",
                "id": "thirty_days",
                "required_plan": null
              },
              {
                "label": "1 year",
                "id": "one_year",
                "required_plan": "enterprise"
              }
            ]
          },
          {
            "label": "relative day",
            "id": "equals_relative_date",
            "type": "list",
            "items": [
              {
                "label": "yesterday",
                "id": "yesterday"
              },
              {
                "label": "today",
                "id": "today"
              },
              {
                "label": "tomorrow",
                "id": "tomorrow"
              }
            ]
          }
        ]
      },
      {
        "label": "Desired start date",
        "id": "desired_start_date",
        "operators": [
          {
            "label": "in the last",
            "id": "in_the_last",
            "type": "list",
            "items": [
              {
                "label": "7 days",
                "id": "seven_days",
                "required_plan": null
              },
              {
                "label": "15 days",
                "id": "fifteen_days",
                "required_plan": null
              },
              {
                "label": "30 days",
                "id": "thirty_days",
                "required_plan": null
              },
              {
                "label": "1 year",
                "id": "one_year",
                "required_plan": "enterprise"
              }
            ]
          },
          {
            "label": "in the next",
            "id": "in_the_next",
            "type": "list",
            "items": [
              {
                "label": "7 days",
                "id": "seven_days",
                "required_plan": null
              },
              {
                "label": "15 days",
                "id": "fifteen_days",
                "required_plan": null
              },
              {
                "label": "30 days",
                "id": "thirty_days",
                "required_plan": null
              },
              {
                "label": "1 year",
                "id": "one_year",
                "required_plan": "enterprise"
              }
            ]
          },
          {
            "label": "relative day",
            "id": "equals_relative_date",
            "type": "list",
            "items": [
              {
                "label": "yesterday",
                "id": "yesterday"
              },
              {
                "label": "today",
                "id": "today"
              },
              {
                "label": "tomorrow",
                "id": "tomorrow"
              }
            ]
          }
        ]
      },
      {
        "label": "Estimated delivery date",
        "id": "estimated_delivery_date",
        "operators": [
          {
            "label": "in the last",
            "id": "in_the_last",
            "type": "list",
            "items": [
              {
                "label": "7 days",
                "id": "seven_days",
                "required_plan": null
              },
              {
                "label": "15 days",
                "id": "fifteen_days",
                "required_plan": null
              },
              {
                "label": "30 days",
                "id": "thirty_days",
                "required_plan": null
              },
              {
                "label": "1 year",
                "id": "one_year",
                "required_plan": "enterprise"
              }
            ]
          },
          {
            "label": "in the next",
            "id": "in_the_next",
            "type": "list",
            "items": [
              {
                "label": "7 days",
                "id": "seven_days",
                "required_plan": null
              },
              {
                "label": "15 days",
                "id": "fifteen_days",
                "required_plan": null
              },
              {
                "label": "30 days",
                "id": "thirty_days",
                "required_plan": null
              },
              {
                "label": "1 year",
                "id": "one_year",
                "required_plan": "enterprise"
              }
            ]
          },
          {
            "label": "relative day",
            "id": "equals_relative_date",
            "type": "list",
            "items": [
              {
                "label": "yesterday",
                "id": "yesterday"
              },
              {
                "label": "today",
                "id": "today"
              },
              {
                "label": "tomorrow",
                "id": "tomorrow"
              }
            ]
          }
        ]
      },
      {
        "label": "Last update",
        "id": "last_activity_at",
        "operators": [
          {
            "label": "in the last",
            "id": "in_the_last",
            "type": "list",
            "items": [
              {
                "label": "7 days",
                "id": "seven_days",
                "required_plan": null
              },
              {
                "label": "15 days",
                "id": "fifteen_days",
                "required_plan": null
              },
              {
                "label": "30 days",
                "id": "thirty_days",
                "required_plan": null
              },
              {
                "label": "1 year",
                "id": "one_year",
                "required_plan": "enterprise"
              }
            ]
          },
          {
            "label": "in the next",
            "id": "in_the_next",
            "type": "list",
            "items": [
              {
                "label": "7 days",
                "id": "seven_days",
                "required_plan": null
              },
              {
                "label": "15 days",
                "id": "fifteen_days",
                "required_plan": null
              },
              {
                "label": "30 days",
                "id": "thirty_days",
                "required_plan": null
              },
              {
                "label": "1 year",
                "id": "one_year",
                "required_plan": "enterprise"
              }
            ]
          },
          {
            "label": "relative day",
            "id": "equals_relative_date",
            "type": "list",
            "items": [
              {
                "label": "yesterday",
                "id": "yesterday"
              },
              {
                "label": "today",
                "id": "today"
              },
              {
                "label": "tomorrow",
                "id": "tomorrow"
              }
            ]
          }
        ]
      },
      {
        "label": "Start date",
        "id": "start_date",
        "operators": [
          {
            "label": "in the last",
            "id": "in_the_last",
            "type": "list",
            "items": [
              {
                "label": "7 days",
                "id": "seven_days",
                "required_plan": null
              },
              {
                "label": "15 days",
                "id": "fifteen_days",
                "required_plan": null
              },
              {
                "label": "30 days",
                "id": "thirty_days",
                "required_plan": null
              },
              {
                "label": "1 year",
                "id": "one_year",
                "required_plan": "enterprise"
              }
            ]
          },
          {
            "label": "in the next",
            "id": "in_the_next",
            "type": "list",
            "items": [
              {
                "label": "7 days",
                "id": "seven_days",
                "required_plan": null
              },
              {
                "label": "15 days",
                "id": "fifteen_days",
                "required_plan": null
              },
              {
                "label": "30 days",
                "id": "thirty_days",
                "required_plan": null
              },
              {
                "label": "1 year",
                "id": "one_year",
                "required_plan": "enterprise"
              }
            ]
          },
          {
            "label": "relative day",
            "id": "equals_relative_date",
            "type": "list",
            "items": [
              {
                "label": "yesterday",
                "id": "yesterday"
              },
              {
                "label": "today",
                "id": "today"
              },
              {
                "label": "tomorrow",
                "id": "tomorrow"
              }
            ]
          }
        ]
      }
    ],
    "period_to_compare_options": [
      {
        "id": "same_days_on_last_period",
        "required_plan": null
      },
      {
        "id": "same_period_on_previous_year",
        "required_plan": "enterprise"
      }
    ],
    "grouping_options": [
      {
        "label": "Client",
        "id": "client",
        "column_types": [
          "client_id",
          "short_text"
        ],
        "details": {
        }
      },
      {
        "label": "Created by",
        "id": "user",
        "column_types": [
          "user_slug",
          "short_text"
        ],
        "details": {
        }
      },
      {
        "label": "Current stage",
        "id": "board_stage",
        "column_types": [
          "short_text"
        ],
        "details": {
        }
      },
      {
        "label": "Delay",
        "id": "overdue",
        "column_types": [
          "overdue"
        ],
        "details": {
          "options": [
            {
              "id": "on_schedule",
              "label": "without delay"
            },
            {
              "id": "soft_overdue",
              "label": "estimated delay"
            },
            {
              "id": "hard_overdue",
              "label": "with delay"
            }
          ]
        }
      },
      {
        "label": "Expected time (SLA) exceeded",
        "id": "is_board_stage_sla_elapsed_time_overdue",
        "column_types": [
          "boolean"
        ],
        "details": {
        }
      },
      {
        "label": "Inactivity timeout exceeded",
        "id": "is_board_stage_sla_last_activity_time_overdue",
        "column_types": [
          "boolean"
        ],
        "details": {
        }
      },
      {
        "label": "Project",
        "id": "project",
        "column_types": [
          "project_id",
          "short_text"
        ],
        "details": {
        }
      },
      {
        "label": "Shared",
        "id": "is_shared",
        "column_types": [
          "boolean"
        ],
        "details": {
        }
      },
      {
        "label": "State",
        "id": "state",
        "column_types": [
          "task_state"
        ],
        "details": {
          "options": [
            {
              "id": "closed",
              "label": "completed"
            },
            {
              "id": "queued",
              "label": "pending"
            },
            {
              "id": "working_on",
              "label": "in development"
            },
            {
              "id": "not_assigned",
              "label": "unassigned"
            }
          ]
        }
      },
      {
        "label": "Tags",
        "id": "tags",
        "column_types": [
          "tags"
        ],
        "details": {
        }
      },
      {
        "label": "Teams assigned",
        "id": "teams",
        "column_types": [
          "team_ids"
        ],
        "details": {
        }
      },
      {
        "label": "Type",
        "id": "task_type",
        "column_types": [
          "type_id",
          "short_text"
        ],
        "details": {
        }
      },
      {
        "label": "Urgent",
        "id": "is_urgent",
        "column_types": [
          "boolean"
        ],
        "details": {
        }
      },
      {
        "label": "Users assigned",
        "id": "assignees",
        "column_types": [
          "user_slugs"
        ],
        "details": {
        }
      }
    ]
  }
]

GET

/api/v1.0/dashboards/:dashboard_id/widgets/templates

List all available templates for a board dashboard

Request

Route

GET /api/v1.0/dashboards/1/widgets/templates

Headers

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

cURL

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

Response

Simulated Response

Status

Headers

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

Body

[
  {
    "id": "lead_time",
    "category": "indicator_recommended",
    "title": "Lead Time",
    "thumbnail": "lead_time",
    "description": "Find out the average time that tasks remain open on your board.",
    "is_available": true,
    "widget_data": {
      "kind": "indicator",
      "restriction": [

      ],
      "aggregation": {
        "function": "avg"
      },
      "parameters": {
        "board_id": 1,
        "axes": [
          {
            "source": "task_trackings",
            "format": "days"
          }
        ],
        "periods": {
          "column_id": "close_date",
          "period_to_analyze": {
            "operator": "in_the_last",
            "value": "thirty_days"
          },
          "period_to_compare": {
            "comparison_type": "same_days_on_last_period",
            "success_indicator": "decrease"
          }
        }
      }
    }
  },
  {
    "id": "open_and_unassigned_tasks",
    "category": "indicator_recommended",
    "title": "Open tasks without assignees",
    "thumbnail": "numbers",
    "description": "Check the number of open tasks without people allocated.",
    "is_available": true,
    "widget_data": {
      "kind": "indicator",
      "restriction": [
        {
          "column_id": "state",
          "operator": "is_not",
          "value": "closed"
        },
        {
          "column_id": "assignees",
          "operator": "is_empty",
          "value": [

          ]
        }
      ],
      "aggregation": {
        "function": "count"
      },
      "parameters": {
        "board_id": 1,
        "axes": [
          {
            "source": "tasks"
          }
        ],
        "periods": {
          "column_id": "created_at",
          "period_to_analyze": {
            "operator": "in_the_last",
            "value": "thirty_days"
          }
        }
      }
    }
  },
  {
    "id": "overdue_tasks",
    "category": "indicator_recommended",
    "title": "Overdue tasks",
    "thumbnail": "numbers",
    "description": "Track the volume of overdue tasks on your board.",
    "is_available": true,
    "widget_data": {
      "kind": "indicator",
      "restriction": [
        {
          "column_id": "state",
          "operator": "is_not",
          "value": "closed"
        },
        {
          "column_id": "overdue",
          "operator": "is",
          "value": "hard_overdue"
        }
      ],
      "aggregation": {
        "function": "count"
      },
      "parameters": {
        "board_id": 1,
        "axes": [
          {
            "source": "tasks"
          }
        ],
        "periods": {
          "column_id": "created_at",
          "period_to_analyze": {
            "operator": "in_the_last",
            "value": "thirty_days"
          }
        }
      }
    }
  },
  {
    "id": "working_on_tasks",
    "category": "indicator_recommended",
    "title": "Running tasks",
    "thumbnail": "numbers",
    "description": "See how many tasks are in progress right now.",
    "is_available": true,
    "widget_data": {
      "kind": "indicator",
      "restriction": [
        {
          "column_id": "state",
          "operator": "is",
          "value": "working_on"
        }
      ],
      "aggregation": {
        "function": "count"
      },
      "parameters": {
        "board_id": 1,
        "axes": [
          {
            "source": "tasks"
          }
        ],
        "periods": {
          "column_id": "created_at",
          "period_to_analyze": {
            "operator": "in_the_last",
            "value": "thirty_days"
          }
        }
      }
    }
  },
  {
    "id": "tasks_to_deliver_today",
    "category": "indicator_recommended",
    "title": "Tasks to be delivered today",
    "thumbnail": "numbers",
    "description": "Keep track of deadlines and visualize the day's priorities.",
    "is_available": true,
    "widget_data": {
      "kind": "indicator",
      "restriction": [
        {
          "column_id": "desired_date",
          "operator": "equals_relative_date",
          "value": "today"
        }
      ],
      "aggregation": {
        "function": "count"
      },
      "parameters": {
        "board_id": 1,
        "axes": [
          {
            "source": "tasks"
          }
        ],
        "periods": {
          "column_id": "created_at",
          "period_to_analyze": {
            "operator": "in_the_last",
            "value": "thirty_days"
          }
        }
      }
    }
  },
  {
    "id": "total_tasks_delivered_by_type_columns",
    "category": "charts_recommended",
    "title": "Total tasks delivered by type",
    "thumbnail": "columns",
    "description": "See the total number of tasks delivered by each type.",
    "is_available": true,
    "widget_data": {
      "kind": "columns_chart",
      "restriction": [

      ],
      "aggregation": {
        "function": "count"
      },
      "parameters": {
        "board_id": 1,
        "axes": [
          {
            "source": "tasks",
            "vector": "vertical"
          },
          {
            "source": "task_type",
            "vector": "horizontal",
            "values": [

            ]
          }
        ],
        "periods": {
          "column_id": "close_date",
          "period_to_analyze": {
            "operator": "in_the_last",
            "value": "thirty_days"
          }
        }
      }
    },
    "required_enterprise_plan": "business"
  },
  {
    "id": "deliveries_on_schedule_vs_with_overdue",
    "category": "charts_recommended",
    "title": "Deliveries on time vs. late",
    "thumbnail": "columns",
    "description": "Track the volume of tasks completed on time and late.",
    "is_available": true,
    "widget_data": {
      "kind": "columns_chart",
      "restriction": [

      ],
      "aggregation": {
        "function": "count"
      },
      "parameters": {
        "board_id": 1,
        "axes": [
          {
            "source": "tasks",
            "vector": "vertical"
          },
          {
            "source": "overdue",
            "vector": "horizontal",
            "values": [
              "on_schedule",
              "hard_overdue"
            ]
          }
        ],
        "periods": {
          "column_id": "close_date",
          "period_to_analyze": {
            "operator": "in_the_last",
            "value": "thirty_days"
          }
        }
      }
    },
    "required_enterprise_plan": "business"
  },
  {
    "id": "total_tasks_delivered_last_thirty_days",
    "category": "charts_recommended",
    "title": "Completions in the last 30 days",
    "thumbnail": "lines",
    "description": "Total tasks completed per day.",
    "is_available": true,
    "widget_data": {
      "kind": "lines_chart",
      "restriction": [

      ],
      "aggregation": {
        "function": "count"
      },
      "parameters": {
        "board_id": 1,
        "axes": [
          {
            "source": "tasks",
            "vector": "vertical"
          },
          {
            "source": "close_date",
            "vector": "horizontal",
            "format": "day"
          }
        ],
        "periods": {
          "column_id": "close_date",
          "period_to_analyze": {
            "operator": "in_the_last",
            "value": "thirty_days"
          }
        }
      }
    },
    "required_enterprise_plan": "business"
  },
  {
    "id": "total_tasks_created_last_thirty_days",
    "category": "charts_recommended",
    "title": "Tasks created in the last 30 days",
    "thumbnail": "lines",
    "description": "Total tasks created per day.",
    "is_available": true,
    "widget_data": {
      "kind": "lines_chart",
      "restriction": [

      ],
      "aggregation": {
        "function": "count"
      },
      "parameters": {
        "board_id": 1,
        "axes": [
          {
            "source": "tasks",
            "vector": "vertical"
          },
          {
            "source": "created_at",
            "vector": "horizontal",
            "format": "day"
          }
        ],
        "periods": {
          "column_id": "created_at",
          "period_to_analyze": {
            "operator": "in_the_last",
            "value": "thirty_days"
          }
        }
      }
    },
    "required_enterprise_plan": "business"
  },
  {
    "id": "percentage_of_tasks_per_task_type",
    "category": "charts_recommended",
    "title": "% of tasks opened by type",
    "thumbnail": "pizza",
    "description": "Check which type of task is most requested.",
    "is_available": true,
    "widget_data": {
      "kind": "pie_chart",
      "restriction": [

      ],
      "aggregation": {
        "function": "count"
      },
      "parameters": {
        "board_id": 1,
        "axes": [
          {
            "source": "tasks",
            "vector": "vertical"
          },
          {
            "source": "task_type",
            "vector": "horizontal",
            "values": [

            ]
          }
        ],
        "periods": {
          "column_id": "created_at",
          "period_to_analyze": {
            "operator": "in_the_last",
            "value": "thirty_days"
          }
        }
      }
    },
    "required_enterprise_plan": "business"
  },
  {
    "id": "percentage_of_tasks_per_overdue_status",
    "category": "charts_recommended",
    "title": "% of deliveries on time vs. late",
    "thumbnail": "pizza",
    "description": "Track the % of tasks completed on time and late.",
    "is_available": true,
    "widget_data": {
      "kind": "pie_chart",
      "restriction": [

      ],
      "aggregation": {
        "function": "count"
      },
      "parameters": {
        "board_id": 1,
        "axes": [
          {
            "source": "tasks",
            "vector": "vertical"
          },
          {
            "source": "overdue",
            "vector": "horizontal",
            "values": [
              "on_schedule",
              "hard_overdue"
            ]
          }
        ],
        "periods": {
          "column_id": "close_date",
          "period_to_analyze": {
            "operator": "in_the_last",
            "value": "thirty_days"
          }
        }
      }
    },
    "required_enterprise_plan": "business"
  },
  {
    "id": "custom_indicators",
    "category": "custom",
    "title": "Numbers",
    "thumbnail": "numbers",
    "description": "Customize numbers and get insights quickly.",
    "is_available": true,
    "widget_data": {
      "kind": "indicator",
      "restriction": [

      ],
      "aggregation": {
        "function": "count"
      },
      "parameters": {
        "board_id": 1,
        "axes": [
          {
            "source": "tasks"
          }
        ],
        "periods": {
          "column_id": "created_at",
          "period_to_analyze": {
            "operator": "in_the_last",
            "value": "thirty_days"
          }
        }
      }
    }
  },
  {
    "id": "custom_columns",
    "category": "custom",
    "title": "Columns",
    "thumbnail": "columns",
    "description": "Create a customized column chart with the data from your board.",
    "is_available": true,
    "widget_data": {
      "kind": "columns_chart",
      "restriction": [

      ],
      "aggregation": {
        "function": "count"
      },
      "parameters": {
        "board_id": 1,
        "axes": [
          {
            "source": "tasks",
            "vector": "vertical"
          }
        ],
        "periods": {
          "column_id": "created_at",
          "period_to_analyze": {
            "operator": "in_the_last",
            "value": "thirty_days"
          }
        }
      }
    },
    "required_enterprise_plan": "business"
  },
  {
    "id": "custom_lines",
    "category": "custom",
    "title": "Lines",
    "thumbnail": "lines",
    "description": "Use the line chart to follow the evolution of data.",
    "is_available": true,
    "widget_data": {
      "kind": "lines_chart",
      "restriction": [

      ],
      "aggregation": {
        "function": "count"
      },
      "parameters": {
        "board_id": 1,
        "axes": [
          {
            "source": "tasks",
            "vector": "vertical"
          }
        ],
        "periods": {
          "column_id": "created_at",
          "period_to_analyze": {
            "operator": "in_the_last",
            "value": "thirty_days"
          }
        }
      }
    },
    "required_enterprise_plan": "business"
  },
  {
    "id": "custom_pie",
    "category": "custom",
    "title": "Pie",
    "thumbnail": "pizza",
    "description": "Check the distribution of information on your board in a pie chart.",
    "is_available": true,
    "widget_data": {
      "kind": "pie_chart",
      "restriction": [

      ],
      "aggregation": {
        "function": "count"
      },
      "parameters": {
        "board_id": 1,
        "axes": [
          {
            "source": "tasks",
            "vector": "vertical"
          }
        ],
        "periods": {
          "column_id": "created_at",
          "period_to_analyze": {
            "operator": "in_the_last",
            "value": "thirty_days"
          }
        }
      }
    },
    "required_enterprise_plan": "business"
  }
]

POST

/api/v1.0/widgets/:id/export

Export widget data

GET

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

Gets processed data for a widget with source tasks

GET

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

Lists tasks for drilldown when expand is passed

Request

Route

GET /api/v1.0/widgets/1/tasks?expand=true&page=1

Headers

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

Query Parameters

expand=true
page=1

cURL

curl -g "https://runrun.it/api/v1.0/widgets/1/tasks?expand=true&page=1" -X GET \
	-H "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

[
  {
    "id": 1,
    "title": "Bla 112",
    "is_working_on": false,
    "user_id": "coyote-264",
    "guest_id": null,
    "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": "2024-11-08T14:02:26-03:00",
    "start_date": null,
    "desired_start_date": null,
    "current_estimate_seconds": 3600,
    "evaluation_status": null,
    "attachments_count": 0,
    "tags_data": [

    ],
    "client_name": "Test client 135",
    "client_id": 1,
    "project_name": "Test project 128",
    "project_group_name": "No group",
    "project_group_id": 1,
    "project_group_is_default": true,
    "project_sub_group_name": "No subgroup",
    "project_sub_group_id": 1,
    "project_sub_group_is_default": true,
    "type_name": "TaskType 148",
    "user_name": "Coyote 264",
    "guest_name": null,
    "board_name": "Board 119",
    "board_stage_name": "Board Stage 369",
    "board_stage_description": null,
    "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,
    "parent_ids": [

    ],
    "opened_parent_ids": [

    ],
    "parents_max_desired_date": null,
    "child_ids": [

    ],
    "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,
    "all_subtasks_time_worked": null,
    "all_subtasks_times_updating": false,
    "all_subtasks_time_total": null,
    "all_subtasks_time_progress": null,
    "current_level": 0,
    "evaluator_ids": null,
    "pending_evaluator_ids": null,
    "approved_evaluator_ids": null,
    "rejected_evaluator_ids": null,
    "custom_fields": {
    },
    "form_id": null,
    "last_activity_at": "2024-11-08T14:02:26-03:00",
    "priority": 1,
    "tag_list": "",
    "tags": [

    ],
    "scheduled_start_time": null,
    "is_scheduled": false,
    "current_evaluator_id": null,
    "assignments": [
      {
        "id": "49537adb9",
        "task_id": 1,
        "assignee_id": "coyote-264",
        "team_id": null,
        "assignee_name": "Coyote 264",
        "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": "2024-11-08T14:02:26-03:00",
        "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-227/coyote-264/mini.png",
        "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-227/coyote-264/regular.png",
        "time_worked_not_persisted": 0
      }
    ]
  }
]

DashboardWidgets

GET

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

List all widgets for the current dashboard

GET

/api/v1.0/dashboard_widgets/:id

List a choosen widget for the current dashboard

GET

/api/v1.0/dashboard_widgets/:id

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

POST

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

Create a widget

PUT

/api/v1.0/dashboard_widgets/:id

Update a dashboard

DELETE

/api/v1.0/dashboard_widgets/:id

Destroy a widget

PUT

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

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": "2024-11-08T14:02:08-03:00",
      "updated_at": "2024-11-08T14:02:08-03:00"
    },
    {
      "id": 2,
      "dashboard_id": 1,
      "widget_id": 2,
      "grid_x": 2,
      "grid_y": 1,
      "grid_w": 1,
      "grid_h": 1,
      "created_at": "2024-11-08T14:02:08-03:00",
      "updated_at": "2024-11-08T14:02:08-03:00"
    },
    {
      "id": 3,
      "dashboard_id": 1,
      "widget_id": 3,
      "grid_x": 1,
      "grid_y": 1,
      "grid_w": 1,
      "grid_h": 1,
      "created_at": "2024-11-08T14:02:08-03:00",
      "updated_at": "2024-11-08T14:02:08-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":"2024-11-08T14:02:08-03:00","updated_at":"2024-11-08T14:02:08-03:00"},{"id":2,"dashboard_id":1,"widget_id":2,"grid_x":2,"grid_y":1,"grid_w":1,"grid_h":1,"created_at":"2024-11-08T14:02:08-03:00","updated_at":"2024-11-08T14:02:08-03:00"},{"id":3,"dashboard_id":1,"widget_id":3,"grid_x":1,"grid_y":1,"grid_w":1,"grid_h":1,"created_at":"2024-11-08T14:02:08-03:00","updated_at":"2024-11-08T14:02:08-03:00"}]}' -X PUT \
	-H "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

[
  {
    "id": 1,
    "dashboard_id": 1,
    "name": "Widget 7",
    "kind": "project_indicator",
    "user_id": "coyote-250",
    "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": "/en-US/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-250",
    "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": "/en-US/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-250",
    "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": "/en-US/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

GET

/api/v1.0/dashboards/:id

List a choosen dashboard for the current_user

POST

/api/v1.0/dashboards

Create a dashboard

PUT

/api/v1.0/dashboards/:id

Update a dashboard

DELETE

/api/v1.0/dashboards/:id

Destroy a dashboard

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-272/demanders

Headers

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

cURL

curl -g "https://runrun.it/api/v1.0/users/coyote-272/demanders" -X GET \
	-H "Version: HTTP/1.0" \
	-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 RR Starter certification	boolean
is_certified_expert	Whether the user has passed RR Expert 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
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
is_eligible_to_access_reports	User can access enterprise reports	boolean
is_eligible_to_whatsapp	User can access whatsapp integration	boolean
theme	[Deprecated] Use preferences.theme	string
task_list_background_image_url	[Deprecated] Use preferences.task_list_background_image_url	string
skip_time_adjust_on_task_assignment_deliver	[Deprecated] Use preferences.skip_time_adjust_on_task_assignment_deliver	boolean
time_tracking_mode	[Deprecated] Use 'time_tracking_mode' from enterprise	string

Status

Headers

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

Body

[
  {
    "id": "coyote-273",
    "name": "Coyote 273",
    "email": "coyote273@acme.foo",
    "avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-234/coyote-273/mini.png",
    "avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-234/coyote-273/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": "2024-11-08T14:02:34-03:00",
    "in_company_since": null,
    "is_certified": false,
    "is_certified_expert": false,
    "language": "en-US",
    "alt_id": "caa87b844b9efede2b0beb23e3f639eb",
    "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,
    "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": [

    ],
    "is_eligible_to_access_reports": false,
    "is_eligible_to_whatsapp": false,
    "theme": "light",
    "task_list_background_image_url": null,
    "skip_time_adjust_on_task_assignment_deliver": false,
    "time_tracking_mode": "manual",
    "preferences": {
      "theme": "light",
      "task_list_background_image_url": null,
      "skip_time_adjust_on_task_assignment_deliver": false,
      "skip_move_task_to_next_board_stage_suggestion": false
    }
  },
  {
    "id": "coyote-272",
    "name": "Coyote 272",
    "email": "coyote272@acme.foo",
    "avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-234/coyote-272/mini.png",
    "avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-234/coyote-272/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": "2024-11-08T14:02:34-03:00",
    "in_company_since": null,
    "is_certified": false,
    "is_certified_expert": false,
    "language": "en-US",
    "alt_id": "e64a9d02fbd74a2e2fcd1a109e1d1230",
    "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,
    "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": [

    ],
    "is_eligible_to_access_reports": false,
    "is_eligible_to_whatsapp": false,
    "theme": "light",
    "task_list_background_image_url": null,
    "skip_time_adjust_on_task_assignment_deliver": false,
    "time_tracking_mode": "manual",
    "preferences": {
      "theme": "light",
      "task_list_background_image_url": null,
      "skip_time_adjust_on_task_assignment_deliver": false,
      "skip_move_task_to_next_board_stage_suggestion": false
    }
  }
]

POST

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

Adds a demander to a user

POST

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

Replace a user partners list

DELETE

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

Destroy a demander of a user

Descendants

GET

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

List all task descendants from a task

Parameters

Name	Description	type
task_id required	ID of the task	integer

Request

Route

GET /api/v1.0/tasks/2/descendants

Headers

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

cURL

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

Response

Simulated Response

Status

Headers

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

Body

[
  {
    "id": 1,
    "title": "Bla 113",
    "is_working_on": false,
    "user_id": "coyote-287",
    "guest_id": null,
    "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": "2024-11-08T14:02:42-03:00",
    "start_date": null,
    "desired_start_date": null,
    "current_estimate_seconds": 3600,
    "evaluation_status": null,
    "attachments_count": 0,
    "tags_data": [

    ],
    "client_name": "Test client 136",
    "client_id": 1,
    "project_name": "Test project 129",
    "project_group_name": "No group",
    "project_group_id": 1,
    "project_group_is_default": true,
    "project_sub_group_name": "No subgroup",
    "project_sub_group_id": 1,
    "project_sub_group_is_default": true,
    "type_name": "TaskType 149",
    "user_name": "Coyote 287",
    "guest_name": null,
    "board_name": "Board 120",
    "board_stage_name": "Board Stage 372",
    "board_stage_description": null,
    "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,
    "parent_ids": [
      2
    ],
    "opened_parent_ids": [
      2
    ],
    "parents_max_desired_date": null,
    "child_ids": [

    ],
    "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,
    "all_subtasks_time_worked": null,
    "all_subtasks_times_updating": false,
    "all_subtasks_time_total": null,
    "all_subtasks_time_progress": null,
    "current_level": 0,
    "evaluator_ids": null,
    "pending_evaluator_ids": null,
    "approved_evaluator_ids": null,
    "rejected_evaluator_ids": null,
    "custom_fields": {
    },
    "form_id": null,
    "last_activity_at": "2024-11-08T14:02:42-03:00",
    "priority": 1,
    "tag_list": "",
    "tags": [

    ],
    "scheduled_start_time": null,
    "is_scheduled": false,
    "current_evaluator_id": null,
    "uid": 1,
    "responsible_id": "coyote-286",
    "task_state_id": 1,
    "responsible_name": "Coyote 286",
    "task_state_name": "Board Stage 372",
    "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 372",
    "assignments": [
      {
        "id": "49537adb9",
        "task_id": 1,
        "assignee_id": "coyote-286",
        "team_id": null,
        "assignee_name": "Coyote 286",
        "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": "2024-11-08T14:02:42-03:00",
        "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-238/coyote-286/mini.png",
        "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-238/coyote-286/regular.png",
        "time_worked_not_persisted": 0
      }
    ],
    "follower_ids": [

    ]
  }
]

POST

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

Add a descendant task to a task

Parameters

Name	Description	type
task_id required	ID of the task	integer

Request

Route

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

Headers

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

Body

{
  "descendant": {
    "id": 2
  }
}

cURL

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

Response

Simulated Response

Status

Headers

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

Body

{
  "id": 2,
  "title": "Bla 116",
  "is_working_on": false,
  "user_id": "coyote-291",
  "guest_id": null,
  "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": "2024-11-08T14:02:45-03:00",
  "start_date": null,
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 139",
  "client_id": 2,
  "project_name": "Test project 132",
  "project_group_name": "No group",
  "project_group_id": 2,
  "project_group_is_default": true,
  "project_sub_group_name": "No subgroup",
  "project_sub_group_id": 2,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 152",
  "user_name": "Coyote 291",
  "guest_name": null,
  "board_name": "Board 123",
  "board_stage_name": "Board Stage 381",
  "board_stage_description": null,
  "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,
  "parent_ids": [
    1
  ],
  "opened_parent_ids": [
    1
  ],
  "parents_max_desired_date": null,
  "child_ids": [

  ],
  "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,
  "all_subtasks_time_worked": null,
  "all_subtasks_times_updating": false,
  "all_subtasks_time_total": null,
  "all_subtasks_time_progress": null,
  "current_level": 0,
  "evaluator_ids": null,
  "pending_evaluator_ids": null,
  "approved_evaluator_ids": null,
  "rejected_evaluator_ids": null,
  "custom_fields": {
  },
  "form_id": null,
  "last_activity_at": "2024-11-08T14:02:45-03:00",
  "priority": 2,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 2,
  "responsible_id": "coyote-289",
  "task_state_id": 4,
  "responsible_name": "Coyote 289",
  "task_state_name": "Board Stage 381",
  "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 381",
  "assignments": [
    {
      "id": "92a6f5b72",
      "task_id": 2,
      "assignee_id": "coyote-289",
      "team_id": null,
      "assignee_name": "Coyote 289",
      "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": "2024-11-08T14:02:45-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-239/coyote-289/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-239/coyote-289/regular.png",
      "time_worked_not_persisted": 0
    }
  ],
  "follower_ids": [

  ]
}

DELETE

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

Remove a descendant task from a task

Description

GET

/api/v1.0/descriptions

Query Multiple Descriptions

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

GET

/api/v1.0/descriptions

Query Single Project Description

Name	Description
task_draft_id	task draft
task_template_id	task template
project_id	project

GET

/api/v1.0/descriptions

Query Single Task Template Description

Name	Description
task_draft_id	task draft
task_template_id	task template
project_id	project

PUT

/api/v1.0/descriptions

Update Project Description

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

PUT

/api/v1.0/descriptions

Update Task Template Description

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

Documents

GET

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

List all documents uploaded to a task

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 -g "https://runrun.it/api/v1.0/documents/1" -X GET \
	-H "Version: HTTP/1.0" \
	-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	Name of the document	string
data_file_size	Size in bytes	integer
data_content_type	MIME type of file	string
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
tags_data	Tags associated with the document	array
has_approval_request	True if the document has an approval request	boolean
field_label	Label of the field associated with the document	string
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

Headers

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

Body

{
  "id": 1,
  "type": "UploadedDocument",
  "data_file_name": "awesome_report_9.txt",
  "data_file_size": 10,
  "data_content_type": "text/plain",
  "file_name": "awesome_report_9.txt",
  "file_size": 10,
  "file_content_type": "text/plain",
  "file_extension": "txt",
  "uploaded_at": "2024-11-08T14:03:07-03:00",
  "transfered": true,
  "uploader_id": "coyote-321",
  "uploader_name": "Coyote 321",
  "attachable_id": 1,
  "attachable_type": "Task",
  "attachable_name": "Bla 122",
  "thumbnail_file_name": null,
  "preview_file_name": null,
  "is_shared": false,
  "tags_data": [

  ],
  "has_approval_request": false,
  "field_label": null,
  "remote_id": null,
  "remote_icon_url": null,
  "evaluations": [

  ]
}

GET

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

Download a document

GET

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

Download a document thumbnail

GET

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

Download a document preview

POST

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

Create a document

Creates a document record and returns the data needed to successfully upload the associated file to Amazon S3.

More information on how to upload a file can be found here.

Parameters

Name	Description	type
document[data_file_name] required	Name of the document	string
document[data_file_size] required	Size in bytes	integer

Request

Route

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

Headers

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

Body

{
  "document": {
    "data_file_name": "example.txt",
    "data_file_size": 4096
  }
}

cURL

curl "https://runrun.it/api/v1.0/tasks/1/documents" -d '{"document":{"data_file_name":"example.txt","data_file_size":4096}}' -X POST \
	-H "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Response Fields

Name	Description	type
fields	List of key/value pairs which need to be sent to Amazon S3 in the POST request	object

Status

Headers

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

Body

{
  "id": 1,
  "type": "UploadedDocument",
  "data_file_name": "example.txt",
  "data_file_size": 4096,
  "data_content_type": "text/plain",
  "file_name": "example.txt",
  "file_size": 4096,
  "file_content_type": "text/plain",
  "file_extension": "txt",
  "uploaded_at": null,
  "transfered": false,
  "uploader_id": "coyote-329",
  "uploader_name": "Coyote 329",
  "attachable_id": 1,
  "attachable_type": "Task",
  "attachable_name": "Bla 126",
  "thumbnail_file_name": null,
  "preview_file_name": null,
  "is_shared": false,
  "tags_data": [

  ],
  "has_approval_request": false,
  "field_label": null,
  "remote_id": null,
  "remote_icon_url": null,
  "evaluations": [

  ],
  "fields": {
    "key": "data/1/example.txt",
    "acl": "private",
    "policy": "eyJleHBpcmF0aW9uIjoiMjAyNC0xMS0wOFQxODowMzoxMloiLCJjb25kaXRpb25zIjpbWyJzdGFydHMtd2l0aCIsIiRrZXkiLCIiXSxbInN0YXJ0cy13aXRoIiwiJEZpbGVuYW1lIiwiIl0sWyJzdGFydHMtd2l0aCIsIiRuYW1lIiwiIl0seyJzdWNjZXNzX2FjdGlvbl9zdGF0dXMiOiIyMDEifSxbImNvbnRlbnQtbGVuZ3RoLXJhbmdlIiwwLDUzNjg3MDkxMjBdLHsiYnVja2V0IjoicnVucnVuaXRfZGV2In0seyJhY2wiOiJwcml2YXRlIn0seyJrZXkiOiJkYXRhLzEvZXhhbXBsZS50eHQifSx7ImNvbnRlbnRfdHlwZSI6InRleHQvcGxhaW4ifV19",
    "signature": "UkwvlPj7NU2ApQSCF7MZ/XupJQE=",
    "AWSAccessKeyId": "ABCDEFGHIJKLMNOPQRST",
    "content_type": "text/plain",
    "filename": "example.txt"
  }
}

DELETE

/api/v1.0/documents/:id

Destroy a document

GET

/api/v1.0/documents/download_zip

Download multiple documents as zip

Name	Description
ids	List of document's ids to download

Enterprises

GET

/api/v1.0/enterprises/:id

Show details for requesting user's enterprise

Request

Route

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

Headers

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

cURL

curl -g "https://runrun.it/api/v1.0/enterprises/acme-322" -X GET \
	-H "Version: HTTP/1.0" \
	-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
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
subscription_expiration_date	Internal use only	date
invite_user_link_code	Internal use only	string
is_beta_tester	Internal use only	boolean
trial_triggered_by	Name of the feature that triggered the trial plan	string
allow_ignore_board_dashboard_limitations	allow ignore board dashboard limitations
default_board_id	Internal use only	integer
use_board_feature	Internal use only	boolean
optional_use_board_feature	Internal use only	boolean
plan[id]	ID of plan	integer
plan[name_pt]	Plan name in Portuguese	string
plan[name_en]	Plan name in English	string
plan[name_es]	Plan name in Spanish	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_widgets_per_boards_dashboard]	Limit of widgets per boards 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
plan[category]	Plan category	string
plan[is_eligible_for_temporary_edition]	Plan eligibility for temporary edition	boolean

Status

Headers

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

Body

{
  "id": "acme-322",
  "name": "Acme 322",
  "avatar_url": "/static/images/enterprise-avatar-fallback.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": "",
  "alt_id": "58f08c4a5f1753d091e0e6ffb027ea8d",
  "oid": "49537adb9",
  "support_phone": "+55 11 2769-9713",
  "trial_days_left": 30,
  "disabled_reason": null,
  "disabled_at": null,
  "currency_symbol": "USD",
  "created_at": "2024-11-08T14:03:52-03:00",
  "master_user_id": "coyote-388",
  "using_temporary_edition": false,
  "temporary_edition_expiration": null,
  "signup_completed": false,
  "signup_qualified": false,
  "time_zone": "America/Sao_Paulo",
  "language": "en-GB",
  "should_see_promo_modal": false,
  "master_user_position": null,
  "subscription_expiration_date": "2024-12-08",
  "invite_user_link_code": null,
  "is_beta_tester": false,
  "trial_triggered_by": [

  ],
  "allow_ignore_board_dashboard_limitations": false,
  "default_board_id": null,
  "use_board_feature": true,
  "optional_use_board_feature": true,
  "plan": {
    "id": 1,
    "name_pt": "Plano Teste",
    "name_en": "Plan Trial",
    "name_es": null,
    "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_widgets_per_boards_dashboard": 36,
    "max_document_size": null,
    "max_period_days": null,
    "is_free": false,
    "is_trial": true,
    "can_use_mobile": true,
    "category": "trial",
    "is_eligible_for_temporary_edition": false
  },
  "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": true,
    "use_project_rr_board": false,
    "feature_task_list_sort_by_priority": true,
    "allow_create_tasks_without_project": true,
    "allow_resource_sharing": true,
    "allow_whatsapp_integration": false,
    "request_time_adjust_on_task_assignment_deliver": false,
    "use_scrum": false,
    "allow_everyone_to_create_portals": true,
    "allow_everyone_to_manage_tags": false,
    "allow_change_descendant_tasks_dates_automatically": true,
    "block_documents_creation": false,
    "allow_everyone_to_perform_batch_actions": true,
    "time_tracking_mode": "manual",
    "factor_for_delivered_tasks": 1,
    "factor_for_reopened_tasks": -2,
    "factor_for_delivered_tasks_on_estimated_time": 2,
    "factor_for_tasks_with_no_more_than_2_estimates": 1,
    "factor_for_delivered_tasks_on_desired_date": 1,
    "factor_for_tasks_created": 1,
    "factor_for_tasks_involved": 1,
    "allow_comments_reply_by_email": true,
    "allow_everyone_to_create_boards": true,
    "allow_avatar_change": true,
    "batch_actions_enabled": true,
    "manual_work_period_change_window": null,
    "use_forms_to_create_tasks": false,
    "use_time_worked": true,
    "use_task_effort": true,
    "use_rr_rating": true,
    "use_gantt": true,
    "use_client_project": true,
    "guest_use_rr_footer": true
  }
}

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-323

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-323" -d '{"enterprise":{"name":"New name"}}' -X PUT \
	-H "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

{
  "id": "acme-323",
  "name": "New name",
  "avatar_url": "/static/images/enterprise-avatar-fallback.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": "",
  "alt_id": "39f0d5278e2db029106916de8be11705",
  "oid": "49537adb9",
  "support_phone": "+55 11 2769-9713",
  "trial_days_left": 30,
  "disabled_reason": null,
  "disabled_at": null,
  "currency_symbol": "USD",
  "created_at": "2024-11-08T14:03:53-03:00",
  "master_user_id": "coyote-389",
  "using_temporary_edition": false,
  "temporary_edition_expiration": null,
  "signup_completed": false,
  "signup_qualified": false,
  "time_zone": "America/Sao_Paulo",
  "language": "en-GB",
  "should_see_promo_modal": false,
  "master_user_position": null,
  "subscription_expiration_date": "2024-12-08",
  "invite_user_link_code": null,
  "is_beta_tester": false,
  "trial_triggered_by": [

  ],
  "allow_ignore_board_dashboard_limitations": false,
  "default_board_id": null,
  "use_board_feature": true,
  "optional_use_board_feature": true,
  "plan": {
    "id": 1,
    "name_pt": "Plano Teste",
    "name_en": "Plan Trial",
    "name_es": null,
    "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_widgets_per_boards_dashboard": 36,
    "max_document_size": null,
    "max_period_days": null,
    "is_free": false,
    "is_trial": true,
    "can_use_mobile": true,
    "category": "trial",
    "is_eligible_for_temporary_edition": false
  },
  "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": true,
    "use_project_rr_board": false,
    "feature_task_list_sort_by_priority": true,
    "allow_create_tasks_without_project": true,
    "allow_resource_sharing": true,
    "allow_whatsapp_integration": false,
    "request_time_adjust_on_task_assignment_deliver": false,
    "use_scrum": false,
    "allow_everyone_to_create_portals": true,
    "allow_everyone_to_manage_tags": false,
    "allow_change_descendant_tasks_dates_automatically": true,
    "block_documents_creation": false,
    "allow_everyone_to_perform_batch_actions": true,
    "time_tracking_mode": "manual",
    "factor_for_delivered_tasks": 1,
    "factor_for_reopened_tasks": -2,
    "factor_for_delivered_tasks_on_estimated_time": 2,
    "factor_for_tasks_with_no_more_than_2_estimates": 1,
    "factor_for_delivered_tasks_on_desired_date": 1,
    "factor_for_tasks_created": 1,
    "factor_for_tasks_involved": 1,
    "allow_comments_reply_by_email": true,
    "allow_everyone_to_create_boards": true,
    "allow_avatar_change": true,
    "batch_actions_enabled": true,
    "manual_work_period_change_window": null,
    "use_forms_to_create_tasks": false,
    "use_time_worked": true,
    "use_task_effort": true,
    "use_rr_rating": true,
    "use_gantt": true,
    "use_client_project": true,
    "guest_use_rr_footer": true
  }
}

Estimates

GET

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

Show all the estimatives for a task.

POST

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

Create a estimative for a task.

EventNotification

GET

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

List all user's event notifications

POST

/api/v1.0/users/:user_id/event_notifications/:id/mark_as_read

Assign readed_in on event_notification

POST

/api/v1.0/users/:user_id/event_notifications/mark_all_as_read

Assigns all user's event notifications

DELETE

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

Delete a event_notification

POST

/api/v1.0/users/:user_id/event_notifications/destroy_all

Delete all event_notifications

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 -g "https://runrun.it/api/v1.0/projects/filters" -X GET \
	-H "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

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

    ],
    "conditions": [

    ],
    "parameters": {
    },
    "sorting": [
      {
        "column_id": "activities",
        "dir": "desc"
      }
    ],
    "sort": {
      "column_id": "activities",
      "dir": "desc"
    },
    "valid": true,
    "default": true,
    "preset": true
  },
  {
    "id": "open",
    "name": "Open projects",
    "status": "all",
    "restriction": [
      {
        "column_id": "open",
        "operator": "is_true",
        "value": null,
        "valid": true
      }
    ],
    "conditions": [
      {
        "column_id": "open",
        "operator": "is_true",
        "value": null,
        "valid": true
      }
    ],
    "parameters": {
    },
    "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 projects",
    "status": "all",
    "restriction": [
      {
        "column_id": "open",
        "operator": "is_false",
        "value": null,
        "valid": true
      }
    ],
    "conditions": [
      {
        "column_id": "open",
        "operator": "is_false",
        "value": null,
        "valid": true
      }
    ],
    "parameters": {
    },
    "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
      }
    ],
    "parameters": {
    },
    "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

DELETE

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

Destroy a project filter

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 -g "https://runrun.it/api/v1.0/tasks/filters" -X GET \
	-H "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

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

    ],
    "conditions": [

    ],
    "parameters": {
    },
    "sorting": [
      {
        "column_id": "activities",
        "dir": "desc"
      }
    ],
    "sort": {
      "column_id": "activities",
      "dir": "desc"
    },
    "valid": true,
    "default": true,
    "preset": true
  },
  {
    "id": "not_assigned",
    "name": "No responsible",
    "status": "all",
    "restriction": [
      {
        "column_id": "assignees",
        "operator": "is_empty",
        "value": [

        ],
        "valid": true
      },
      {
        "column_id": "state",
        "operator": "is_not",
        "value": {
          "id": "closed",
          "name": "completed"
        },
        "valid": true
      }
    ],
    "conditions": [
      {
        "column_id": "assignees",
        "operator": "is_empty",
        "value": [

        ],
        "valid": true
      },
      {
        "column_id": "state",
        "operator": "is_not",
        "value": {
          "id": "closed",
          "name": "completed"
        },
        "valid": true
      }
    ],
    "parameters": {
    },
    "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": "Assigned (Pending)",
    "status": "all",
    "restriction": [
      {
        "column_id": "state",
        "operator": "is",
        "value": {
          "id": "queued",
          "name": "pending"
        },
        "valid": true
      }
    ],
    "conditions": [
      {
        "column_id": "state",
        "operator": "is",
        "value": {
          "id": "queued",
          "name": "pending"
        },
        "valid": true
      }
    ],
    "parameters": {
    },
    "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": "Assigned (In development)",
    "status": "all",
    "restriction": [
      {
        "column_id": "state",
        "operator": "is",
        "value": {
          "id": "working_on",
          "name": "in development"
        },
        "valid": true
      }
    ],
    "conditions": [
      {
        "column_id": "state",
        "operator": "is",
        "value": {
          "id": "working_on",
          "name": "in development"
        },
        "valid": true
      }
    ],
    "parameters": {
    },
    "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": "Opened",
    "status": "all",
    "restriction": [
      {
        "column_id": "state",
        "operator": "is_not",
        "value": {
          "id": "closed",
          "name": "completed"
        },
        "valid": true
      }
    ],
    "conditions": [
      {
        "column_id": "state",
        "operator": "is_not",
        "value": {
          "id": "closed",
          "name": "completed"
        },
        "valid": true
      }
    ],
    "parameters": {
    },
    "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": {
          "id": "closed",
          "name": "completed"
        },
        "valid": true
      }
    ],
    "conditions": [
      {
        "column_id": "state",
        "operator": "is",
        "value": {
          "id": "closed",
          "name": "completed"
        },
        "valid": true
      }
    ],
    "parameters": {
    },
    "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": {
          "id": "closed",
          "name": "completed"
        },
        "valid": true
      }
    ],
    "conditions": [
      {
        "column_id": "close_date",
        "operator": "in_the_last",
        "value": "seven_days",
        "valid": true
      },
      {
        "column_id": "state",
        "operator": "is",
        "value": {
          "id": "closed",
          "name": "completed"
        },
        "valid": true
      }
    ],
    "parameters": {
    },
    "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": "To be delivered 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": {
          "id": "closed",
          "name": "completed"
        },
        "valid": true
      }
    ],
    "conditions": [
      {
        "column_id": "estimated_delivery_date",
        "operator": "in_the_next",
        "value": "seven_days",
        "valid": true
      },
      {
        "column_id": "state",
        "operator": "is_not",
        "value": {
          "id": "closed",
          "name": "completed"
        },
        "valid": true
      }
    ],
    "parameters": {
    },
    "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": {
          "id": "hard_overdue",
          "name": "with delay"
        },
        "valid": true
      },
      {
        "column_id": "state",
        "operator": "is_not",
        "value": {
          "id": "closed",
          "name": "completed"
        },
        "valid": true
      }
    ],
    "conditions": [
      {
        "column_id": "overdue",
        "operator": "is",
        "value": {
          "id": "hard_overdue",
          "name": "with delay"
        },
        "valid": true
      },
      {
        "column_id": "state",
        "operator": "is_not",
        "value": {
          "id": "closed",
          "name": "completed"
        },
        "valid": true
      }
    ],
    "parameters": {
    },
    "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": "With overdue estimated",
    "status": "all",
    "restriction": [
      {
        "column_id": "overdue",
        "operator": "is",
        "value": {
          "id": "soft_overdue",
          "name": "estimated delay"
        },
        "valid": true
      },
      {
        "column_id": "state",
        "operator": "is_not",
        "value": {
          "id": "closed",
          "name": "completed"
        },
        "valid": true
      }
    ],
    "conditions": [
      {
        "column_id": "overdue",
        "operator": "is",
        "value": {
          "id": "soft_overdue",
          "name": "estimated delay"
        },
        "valid": true
      },
      {
        "column_id": "state",
        "operator": "is_not",
        "value": {
          "id": "closed",
          "name": "completed"
        },
        "valid": true
      }
    ],
    "parameters": {
    },
    "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
      }
    ],
    "parameters": {
    },
    "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": {
          "id": "queued",
          "name": "pending"
        },
        "valid": true
      }
    ],
    "conditions": [
      {
        "column_id": "title",
        "operator": "contains",
        "value": "Test",
        "valid": true
      },
      {
        "column_id": "state",
        "operator": "is",
        "value": {
          "id": "queued",
          "name": "pending"
        },
        "valid": true
      }
    ],
    "parameters": {
    },
    "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

DELETE

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

Destroy a task filter

Justifications

POST

/api/v1.0/justifications

Create an arbitrary Justification

POST

/api/v1.0/justifications

Create an arbitrary Justification for a task

PUT

/api/v1.0/justifications/:justification_id

Update the text of a justification

Name	Description	type
user_id required	User's id	integer
date required	Justification's date	date
text	Justification's text	string
task_id	Task's id	integer
task_title	Task title	string

Justifications

POST

/api/v1.0/justifications

Create an arbitrary Justification

POST

/api/v1.0/justifications

Create an arbitrary Justification for a task

PUT

/api/v1.0/justifications/:justification_id

Update the text of a justification

Name	Description	type
user_id required	User's id	integer
date required	Justification's date	date
text	Justification's text	string
task_id	Task's id	integer
task_title	Task title	string

Manual Work Periods

GET

/api/v1.0/manual_work_periods

List all manual work periods

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 -g "https://runrun.it/api/v1.0/manual_work_periods/1" -X GET \
	-H "Version: HTTP/1.0" \
	-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

Headers

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

Body

{
  "id": 1,
  "task_id": 1,
  "seconds": 1000,
  "date_to_apply": "2019-02-08",
  "worker_name": "Coyote 575",
  "user_id": "coyote-575",
  "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]	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]	Date time was worked	date
manual_work_period[seconds]	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 "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

{
  "id": 1,
  "task_id": 1,
  "seconds": 3600,
  "date_to_apply": "2019-02-08",
  "worker_name": "Coyote 576",
  "user_id": "coyote-576",
  "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

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

DELETE

/api/v1.0/manual_work_periods/:id

Destroy a Manual Work Period

OffDays

GET

/api/v1.0/off_days

List all off days

Parameters

Name	Description	type
from	From date	date
to	Up to date	date
sort	Sort by column	string
sort_dir	Sort direction ('asc' or 'desc')	string
search_term	Filter by term	string
filter_id	Filter by an existing filter	integer

Request

Route

GET /api/v1.0/off_days

Headers

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

cURL

curl -g "https://runrun.it/api/v1.0/off_days" -X GET \
	-H "Version: HTTP/1.0" \
	-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 off day	integer
day	Date the off day occurs on	date
description	Name/description of off day	string

Status

Headers

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

Body

[
  {
    "id": 2,
    "day": "2024-11-10",
    "description": "Ice Cream Day"
  },
  {
    "id": 1,
    "day": "2024-11-09",
    "description": "Developer Day"
  }
]

GET

/api/v1.0/off_days/:id

Show an off day

POST

/api/v1.0/off_days

Create an off day

PUT

/api/v1.0/off_days/:id

Update an off day

DELETE

/api/v1.0/off_days/:id

Destroy an off day

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

Headers

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

cURL

curl -g "https://runrun.it/api/v1.0/users/coyote-601/partners" -X GET \
	-H "Version: HTTP/1.0" \
	-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 RR Starter certification	boolean
is_certified_expert	Whether the user has passed RR Expert 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
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
is_eligible_to_access_reports	User can access enterprise reports	boolean
is_eligible_to_whatsapp	User can access whatsapp integration	boolean
theme	[Deprecated] Use preferences.theme	string
task_list_background_image_url	[Deprecated] Use preferences.task_list_background_image_url	string
skip_time_adjust_on_task_assignment_deliver	[Deprecated] Use preferences.skip_time_adjust_on_task_assignment_deliver	boolean
time_tracking_mode	[Deprecated] Use 'time_tracking_mode' from enterprise	string

Status

Headers

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

Body

[
  {
    "id": "coyote-602",
    "name": "Coyote 602",
    "email": "coyote596@acme.foo",
    "avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-575/coyote-602/mini.png",
    "avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-575/coyote-602/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": "2024-11-08T14:06:59-03:00",
    "in_company_since": null,
    "is_certified": false,
    "is_certified_expert": false,
    "language": "en-US",
    "alt_id": "5bc75ac4922cc7d6df64b28dfa5cc87b",
    "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,
    "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": [

    ],
    "is_eligible_to_access_reports": false,
    "is_eligible_to_whatsapp": false,
    "theme": "light",
    "task_list_background_image_url": null,
    "skip_time_adjust_on_task_assignment_deliver": false,
    "time_tracking_mode": "manual",
    "is_authorized": true,
    "preferences": {
      "theme": "light",
      "task_list_background_image_url": null,
      "skip_time_adjust_on_task_assignment_deliver": false,
      "skip_move_task_to_next_board_stage_suggestion": false
    }
  },
  {
    "id": "coyote-601",
    "name": "Coyote 601",
    "email": "coyote595@acme.foo",
    "avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-575/coyote-601/mini.png",
    "avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-575/coyote-601/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": "2024-11-08T14:06:59-03:00",
    "in_company_since": null,
    "is_certified": false,
    "is_certified_expert": false,
    "language": "en-US",
    "alt_id": "7256b593aa0044ec085feba357802b39",
    "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,
    "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": [

    ],
    "is_eligible_to_access_reports": false,
    "is_eligible_to_whatsapp": false,
    "theme": "light",
    "task_list_background_image_url": null,
    "skip_time_adjust_on_task_assignment_deliver": false,
    "time_tracking_mode": "manual",
    "is_authorized": true,
    "preferences": {
      "theme": "light",
      "task_list_background_image_url": null,
      "skip_time_adjust_on_task_assignment_deliver": false,
      "skip_move_task_to_next_board_stage_suggestion": false
    }
  }
]

POST

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

Adds a partner to a user

POST

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

Replace a user partners list

DELETE

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

Destroy a partner of a user

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 -g "https://runrun.it/api/v1.0/tasks/1/prerequisites" -X GET \
	-H "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

[
  {
    "id": 2,
    "title": "Bla 161",
    "is_working_on": false,
    "user_id": "coyote-714",
    "guest_id": null,
    "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": "2024-11-08T14:08:13-03:00",
    "start_date": null,
    "desired_start_date": null,
    "current_estimate_seconds": 3600,
    "evaluation_status": null,
    "attachments_count": 0,
    "tags_data": [

    ],
    "client_name": "Test client 293",
    "client_id": 2,
    "project_name": "Test project 287",
    "project_group_name": "No group",
    "project_group_id": 2,
    "project_group_is_default": true,
    "project_sub_group_name": "No subgroup",
    "project_sub_group_id": 2,
    "project_sub_group_is_default": true,
    "type_name": "TaskType 317",
    "user_name": "Coyote 714",
    "guest_name": null,
    "board_name": "Board 274",
    "board_stage_name": "Board Stage 840",
    "board_stage_description": null,
    "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,
    "parent_ids": [

    ],
    "opened_parent_ids": [

    ],
    "parents_max_desired_date": null,
    "child_ids": [
      1
    ],
    "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,
    "all_subtasks_time_worked": null,
    "all_subtasks_times_updating": false,
    "all_subtasks_time_total": null,
    "all_subtasks_time_progress": null,
    "current_level": 0,
    "evaluator_ids": null,
    "pending_evaluator_ids": null,
    "approved_evaluator_ids": null,
    "rejected_evaluator_ids": null,
    "custom_fields": {
    },
    "form_id": null,
    "last_activity_at": "2024-11-08T14:08:13-03:00",
    "priority": 2,
    "tag_list": "",
    "tags": [

    ],
    "scheduled_start_time": null,
    "is_scheduled": false,
    "current_evaluator_id": null,
    "uid": 2,
    "responsible_id": "coyote-712",
    "task_state_id": 4,
    "responsible_name": "Coyote 712",
    "task_state_name": "Board Stage 840",
    "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 840",
    "assignments": [
      {
        "id": "92a6f5b72",
        "task_id": 2,
        "assignee_id": "coyote-712",
        "team_id": null,
        "assignee_name": "Coyote 712",
        "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": "2024-11-08T14:08:13-03:00",
        "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-654/coyote-712/mini.png",
        "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-654/coyote-712/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 "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

{
  "id": 2,
  "title": "Bla 163",
  "is_working_on": false,
  "user_id": "coyote-717",
  "guest_id": null,
  "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": "2024-11-08T14:08:16-03:00",
  "start_date": null,
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 295",
  "client_id": 2,
  "project_name": "Test project 289",
  "project_group_name": "No group",
  "project_group_id": 2,
  "project_group_is_default": true,
  "project_sub_group_name": "No subgroup",
  "project_sub_group_id": 2,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 319",
  "user_name": "Coyote 717",
  "guest_name": null,
  "board_name": "Board 276",
  "board_stage_name": "Board Stage 846",
  "board_stage_description": null,
  "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,
  "parent_ids": [

  ],
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "child_ids": [
    1
  ],
  "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,
  "all_subtasks_time_worked": null,
  "all_subtasks_times_updating": false,
  "all_subtasks_time_total": null,
  "all_subtasks_time_progress": null,
  "current_level": 0,
  "evaluator_ids": null,
  "pending_evaluator_ids": null,
  "approved_evaluator_ids": null,
  "rejected_evaluator_ids": null,
  "custom_fields": {
  },
  "form_id": null,
  "last_activity_at": "2024-11-08T14:08:16-03:00",
  "priority": 2,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 2,
  "responsible_id": "coyote-715",
  "task_state_id": 4,
  "responsible_name": "Coyote 715",
  "task_state_name": "Board Stage 846",
  "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 846",
  "assignments": [
    {
      "id": "92a6f5b72",
      "task_id": 2,
      "assignee_id": "coyote-715",
      "team_id": null,
      "assignee_name": "Coyote 715",
      "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": "2024-11-08T14:08:16-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-655/coyote-715/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-655/coyote-715/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

GET

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

List all task template prerequisites from a task template

POST

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

Add a task template prerequisite to a task template

DELETE

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

Remove a task template prerequisite from a task template

Project Description

PUT

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

Update the project description

Parameters

Name	Description	type
description	The text of the description	text
current_editor_id	ID of user that is editing the description	string
current_editor_name	Name of user that is editing the description	string
edited_at	Datetime the description has been edited	datetime
locked_at	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": "2024-11-08T14:08:34-03:00",
    "updated_at": "2024-11-08T14:08:34-03:00",
    "edited_at": "2024-11-08T14:08:34-03:00",
    "current_editor_id": null,
    "locked_at": 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,
    "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":"2024-11-08T14:08:34-03:00","updated_at":"2024-11-08T14:08:34-03:00","edited_at":"2024-11-08T14:08:34-03:00","current_editor_id":null,"locked_at":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,"enterprise_id":null}}' -X PUT \
	-H "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

{
  "id": 1,
  "description": "Gorgeous!",
  "current_editor_id": null,
  "current_editor_name": null,
  "edited_at": "2024-11-08T14:08:34-03:00",
  "locked_at": null
}

Project Description

PUT

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

Update the project description

Parameters

Name	Description	type
description	The text of the description	text
current_editor_id	ID of user that is editing the description	string
current_editor_name	Name of user that is editing the description	string
edited_at	Datetime the description has been edited	datetime
locked_at	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": "2024-11-08T14:08:34-03:00",
    "updated_at": "2024-11-08T14:08:34-03:00",
    "edited_at": "2024-11-08T14:08:34-03:00",
    "current_editor_id": null,
    "locked_at": 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,
    "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":"2024-11-08T14:08:34-03:00","updated_at":"2024-11-08T14:08:34-03:00","edited_at":"2024-11-08T14:08:34-03:00","current_editor_id":null,"locked_at":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,"enterprise_id":null}}' -X PUT \
	-H "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

{
  "id": 1,
  "description": "Gorgeous!",
  "current_editor_id": null,
  "current_editor_name": null,
  "edited_at": "2024-11-08T14:08:34-03:00",
  "locked_at": null
}

Project Groups

GET

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

List all Project Groups

GET

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

Show a Project Group

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	Name of project group	string
is_default	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 "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

{
  "id": 2,
  "name": "Project Group 2",
  "is_default": false,
  "client_id": 1,
  "client_name": "Test client 305",
  "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": "2024-11-08T14:08:50-03:00",
      "updated_at": "2024-11-08T14:08:50-03:00"
    }
  ]
}

PUT

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

Update a Project Group

DELETE

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

Destroy a Project Group

POST

/api/v1.0/project_groups/:id/move

Move project group to another client

Project Groups

GET

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

List all Project Groups

GET

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

Show a Project Group

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	Name of project group	string
is_default	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 "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

{
  "id": 2,
  "name": "Project Group 2",
  "is_default": false,
  "client_id": 1,
  "client_name": "Test client 305",
  "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": "2024-11-08T14:08:50-03:00",
      "updated_at": "2024-11-08T14:08:50-03:00"
    }
  ]
}

PUT

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

Update a Project Group

DELETE

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

Destroy a Project Group

POST

/api/v1.0/project_groups/:id/move

Move project group to another client

Project Sub Groups

GET

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

List all Project Sub Groups using Project Group id

GET

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

List all Project Sub Groups using Client id

GET

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

Show a Project Sub Group

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	Name of project group	string
is_default	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 "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

{
  "id": 3,
  "name": "Project Sub Group 4",
  "is_default": false,
  "project_group_id": 2,
  "client_name": "Test client 313",
  "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

DELETE

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

Destroy a Project Sub Group

POST

/api/v1.0/project_sub_groups/:id/move

Move project sub group to another project group

Project Templates

GET

/api/v1.0/project_templates

List all Project Templates

GET

/api/v1.0/project_templates/:id

Show a Project Template

POST

/api/v1.0/project_templates/

Create a Project Template

PUT

/api/v1.0/project_templates/:id

Update a Project Template

DELETE

/api/v1.0/project_templates/:id

Destroy a Project Template

ProjectExtraCost

GET

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

List all extra costs of a project

GET

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

Show a extra cost of a project

POST

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

Create a new Project Extra Cost

ProjectExtraCost

GET

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

List all extra costs of a project

GET

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

Show a extra cost of a project

POST

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

Create a new Project Extra Cost

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 -g "https://runrun.it/api/v1.0/projects" -X GET \
	-H "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

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": "2024-11-08T14:09:18-03:00",
    "is_public": true,
    "is_shared": false,
    "sharing_details": [

    ],
    "use_new_permissions": true,
    "board_stage_id": null,
    "client_name": "Test client 319",
    "project_group_name": "No group",
    "project_group_is_default": true,
    "project_sub_group_name": "No subgroup",
    "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,
    "cost_progress": null,
    "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
  }
]

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 -g "https://runrun.it/api/v1.0/projects/1" -X GET \
	-H "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 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": "2024-11-08T14:09:24-03:00",
  "is_public": true,
  "is_shared": false,
  "sharing_details": [

  ],
  "use_new_permissions": true,
  "board_stage_id": null,
  "client_name": "Test client 323",
  "project_group_name": "No group",
  "project_group_is_default": true,
  "project_sub_group_name": "No subgroup",
  "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,
  "cost_progress": null,
  "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
}

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 "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

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": "2024-11-08T14:09:25-03:00",
  "is_public": true,
  "is_shared": false,
  "sharing_details": [

  ],
  "use_new_permissions": true,
  "board_stage_id": null,
  "client_name": "Test client 324",
  "project_group_name": "No group",
  "project_group_is_default": true,
  "project_sub_group_name": "No subgroup",
  "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,
  "cost_progress": null,
  "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
}

GET

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

List users related in a project

Related users:

responsible
owners
followers

Parameters

Name	Description	type
id required	ID of project	integer

Request

Route

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

Headers

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

cURL

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

Response

Simulated Response

Status

Headers

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

Body

[
  {
    "id": "coyote-784",
    "name": "Coyote 784",
    "email": "coyote778@acme.foo",
    "avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-712/coyote-784/mini.png",
    "avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-712/coyote-784/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": "2024-11-08T14:09:29-03:00",
    "in_company_since": null,
    "is_certified": false,
    "is_certified_expert": false,
    "language": "en-US",
    "alt_id": "3da419f31ecacfed186be70aa9f0fb92",
    "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,
    "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": [

    ],
    "is_eligible_to_access_reports": false,
    "is_eligible_to_whatsapp": false,
    "theme": "light",
    "task_list_background_image_url": null,
    "skip_time_adjust_on_task_assignment_deliver": false,
    "time_tracking_mode": "manual",
    "preferences": {
      "theme": "light",
      "task_list_background_image_url": null,
      "skip_time_adjust_on_task_assignment_deliver": false,
      "skip_move_task_to_next_board_stage_suggestion": false
    }
  }
]

POST

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

Move project to another client

Request

Route

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

Headers

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

Body

{
  "client_id": 2
}

cURL

curl "https://runrun.it/api/v1.0/projects/1/move" -d '{"client_id":2}' -X POST \
	-H "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

{
  "id": 1,
  "name": "Project A",
  "start_date": null,
  "close_date": null,
  "is_closed": false,
  "client_id": 2,
  "project_group_id": 3,
  "project_sub_group_id": 4,
  "budgeted_cost": 0.0,
  "desired_date": null,
  "created_at": "2024-11-08T14:09:30-03:00",
  "is_public": true,
  "is_shared": false,
  "sharing_details": [

  ],
  "use_new_permissions": true,
  "board_stage_id": null,
  "client_name": "Client B",
  "project_group_name": "No group",
  "project_group_is_default": true,
  "project_sub_group_name": "No subgroup",
  "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,
  "cost_progress": null,
  "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
}

POST

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

Move project to another project group

Request

Route

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

Headers

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

Body

{
  "project_group_id": 4
}

cURL

curl "https://runrun.it/api/v1.0/projects/1/move" -d '{"project_group_id":4}' -X POST \
	-H "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

{
  "id": 1,
  "name": "Project A",
  "start_date": null,
  "close_date": null,
  "is_closed": false,
  "client_id": 2,
  "project_group_id": 4,
  "project_sub_group_id": 5,
  "budgeted_cost": 0.0,
  "desired_date": null,
  "created_at": "2024-11-08T14:09:31-03:00",
  "is_public": true,
  "is_shared": false,
  "sharing_details": [

  ],
  "use_new_permissions": true,
  "board_stage_id": null,
  "client_name": "Client B",
  "project_group_name": "Project Group B",
  "project_group_is_default": false,
  "project_sub_group_name": "No subgroup",
  "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,
  "cost_progress": null,
  "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
}

POST

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

Move project to another project sub group

Request

Route

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

Headers

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

Body

{
  "project_sub_group_id": 6
}

cURL

curl "https://runrun.it/api/v1.0/projects/1/move" -d '{"project_sub_group_id":6}' -X POST \
	-H "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

{
  "id": 1,
  "name": "Project A",
  "start_date": null,
  "close_date": null,
  "is_closed": false,
  "client_id": 2,
  "project_group_id": 4,
  "project_sub_group_id": 6,
  "budgeted_cost": 0.0,
  "desired_date": null,
  "created_at": "2024-11-08T14:09:32-03:00",
  "is_public": true,
  "is_shared": false,
  "sharing_details": [

  ],
  "use_new_permissions": true,
  "board_stage_id": null,
  "client_name": "Client B",
  "project_group_name": "Project Group B",
  "project_group_is_default": false,
  "project_sub_group_name": "Project Sub Group B",
  "project_sub_group_is_default": false,
  "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,
  "cost_progress": null,
  "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
}

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	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 "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

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": "2024-11-08T14:09:34-03:00",
  "is_public": true,
  "is_shared": true,
  "sharing_details": [
    "desired_date"
  ],
  "use_new_permissions": true,
  "board_stage_id": null,
  "client_name": "Test client 328",
  "project_group_name": "No group",
  "project_group_is_default": true,
  "project_sub_group_name": "No subgroup",
  "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,
  "cost_progress": null,
  "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
}

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 "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 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": "2024-11-08T14:09:37-03:00",
  "is_public": true,
  "is_shared": false,
  "sharing_details": [

  ],
  "use_new_permissions": true,
  "board_stage_id": null,
  "client_name": "Test client 329",
  "project_group_name": "No group",
  "project_group_is_default": true,
  "project_sub_group_name": "No subgroup",
  "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,
  "cost_progress": null,
  "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
}

POST

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

Clone a Project

POST

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

Change a project board stage

Request

Route

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

Headers

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

Body

{
  "board_stage_id": 1
}

cURL

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

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 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": "2024-11-08T14:09:39-03:00",
  "is_public": true,
  "is_shared": false,
  "sharing_details": [

  ],
  "use_new_permissions": true,
  "board_stage_id": 1,
  "client_name": "Test client 331",
  "project_group_name": "No group",
  "project_group_is_default": true,
  "project_sub_group_name": "No subgroup",
  "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,
  "cost_progress": null,
  "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": "test stage 9",
  "board_stage_color": "FFFFFF",
  "activities_7_days_ago": 0,
  "time_pending_backlog": 0,
  "tasks_backlog_count": 0,
  "is_active": true
}

Task Description

GET

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

Show the task description

PUT

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

Update the task description

Update a task description.

Parameters

Name	Description	type
description	The text of the description	text
current_editor_id	ID of user that is editing the description	string
current_editor_name	Name of user that is editing the description	string
edited_at	Datetime the description has been edited	datetime
locked_at	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": 778,
    "created_at": null,
    "updated_at": null,
    "current_editor_id": null,
    "edited_at": null,
    "locked_at": null,
    "enterprise_id": null
  }
}

cURL

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

Response

Simulated Response

Status

Headers

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

Body

{
  "id": 1,
  "description": "Gorgeous!",
  "current_editor_id": null,
  "current_editor_name": null,
  "edited_at": "2024-11-08T14:11:16-03:00",
  "locked_at": null
}

Task Evaluations

GET

/api/v1.0/task_evaluations

List all task evaluations when no params are passed

Request

Route

GET /api/v1.0/task_evaluations

Headers

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

cURL

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

Response

Simulated Response

Status

Headers

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

Body

[
  {
    "id": 3,
    "state": "pending",
    "happened_at": null,
    "evaluator_id": "coyote-951",
    "evaluator_name": "Coyote 951",
    "evaluator_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-823/coyote-951/mini.png",
    "evaluator_is_deleted": false,
    "task": {
      "id": 3,
      "title": "Third task",
      "is_working_on": false,
      "user_id": "coyote-950",
      "guest_id": null,
      "type_id": 3,
      "project_id": 3,
      "team_id": null,
      "board_id": 3,
      "board_stage_id": 7,
      "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": "2024-11-08T14:11:56-03:00",
      "start_date": null,
      "desired_start_date": null,
      "current_estimate_seconds": 3600,
      "evaluation_status": null,
      "attachments_count": 0,
      "tags_data": [

      ],
      "client_name": "Test client 395",
      "client_id": 3,
      "project_name": "Test project 364",
      "project_group_name": "No group",
      "project_group_id": 3,
      "project_group_is_default": true,
      "project_sub_group_name": "No subgroup",
      "project_sub_group_id": 3,
      "project_sub_group_is_default": true,
      "type_name": "TaskType 404",
      "user_name": "Coyote 950",
      "guest_name": null,
      "board_name": "Board 341",
      "board_stage_name": "Board Stage 1041",
      "board_stage_description": null,
      "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,
      "parent_ids": [

      ],
      "opened_parent_ids": [

      ],
      "parents_max_desired_date": null,
      "child_ids": [

      ],
      "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,
      "all_subtasks_time_worked": null,
      "all_subtasks_times_updating": false,
      "all_subtasks_time_total": null,
      "all_subtasks_time_progress": null,
      "current_level": 0,
      "evaluator_ids": null,
      "pending_evaluator_ids": null,
      "approved_evaluator_ids": null,
      "rejected_evaluator_ids": null,
      "custom_fields": {
      },
      "form_id": null,
      "last_activity_at": "2024-11-08T14:11:56-03:00",
      "priority": 1,
      "tag_list": "",
      "tags": [

      ],
      "scheduled_start_time": null,
      "is_scheduled": false,
      "current_evaluator_id": null,
      "assignments": [
        {
          "id": "dbfa7092b",
          "task_id": 3,
          "assignee_id": "coyote-950",
          "team_id": null,
          "assignee_name": "Coyote 950",
          "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": "2024-11-08T14:11:56-03:00",
          "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-823/coyote-950/mini.png",
          "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-823/coyote-950/regular.png",
          "time_worked_not_persisted": 0
        }
      ]
    }
  },
  {
    "id": 2,
    "state": "pending",
    "happened_at": null,
    "evaluator_id": "coyote-948",
    "evaluator_name": "Coyote 948",
    "evaluator_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-823/coyote-948/mini.png",
    "evaluator_is_deleted": false,
    "task": {
      "id": 2,
      "title": "Second task",
      "is_working_on": false,
      "user_id": "coyote-949",
      "guest_id": null,
      "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": 1,
      "created_at": "2024-11-08T14:11:55-03:00",
      "start_date": null,
      "desired_start_date": null,
      "current_estimate_seconds": 3600,
      "evaluation_status": null,
      "attachments_count": 0,
      "tags_data": [

      ],
      "client_name": "Test client 394",
      "client_id": 2,
      "project_name": "Test project 363",
      "project_group_name": "No group",
      "project_group_id": 2,
      "project_group_is_default": true,
      "project_sub_group_name": "No subgroup",
      "project_sub_group_id": 2,
      "project_sub_group_is_default": true,
      "type_name": "TaskType 403",
      "user_name": "Coyote 949",
      "guest_name": null,
      "board_name": "Board 340",
      "board_stage_name": "Board Stage 1038",
      "board_stage_description": null,
      "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,
      "parent_ids": [

      ],
      "opened_parent_ids": [

      ],
      "parents_max_desired_date": null,
      "child_ids": [

      ],
      "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,
      "all_subtasks_time_worked": null,
      "all_subtasks_times_updating": false,
      "all_subtasks_time_total": null,
      "all_subtasks_time_progress": null,
      "current_level": 0,
      "evaluator_ids": null,
      "pending_evaluator_ids": null,
      "approved_evaluator_ids": null,
      "rejected_evaluator_ids": null,
      "custom_fields": {
      },
      "form_id": null,
      "last_activity_at": "2024-11-08T14:11:55-03:00",
      "priority": 1,
      "tag_list": "",
      "tags": [

      ],
      "scheduled_start_time": null,
      "is_scheduled": false,
      "current_evaluator_id": null,
      "assignments": [
        {
          "id": "92a6f5b72",
          "task_id": 2,
          "assignee_id": "coyote-949",
          "team_id": null,
          "assignee_name": "Coyote 949",
          "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": "2024-11-08T14:11:55-03:00",
          "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-823/coyote-949/mini.png",
          "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-823/coyote-949/regular.png",
          "time_worked_not_persisted": 0
        }
      ]
    }
  },
  {
    "id": 1,
    "state": "pending",
    "happened_at": null,
    "evaluator_id": "coyote-948",
    "evaluator_name": "Coyote 948",
    "evaluator_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-823/coyote-948/mini.png",
    "evaluator_is_deleted": false,
    "task": {
      "id": 1,
      "title": "First task",
      "is_working_on": false,
      "user_id": "coyote-947",
      "guest_id": null,
      "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": "2024-11-08T14:11:55-03:00",
      "start_date": null,
      "desired_start_date": null,
      "current_estimate_seconds": 3600,
      "evaluation_status": null,
      "attachments_count": 0,
      "tags_data": [

      ],
      "client_name": "Test client 393",
      "client_id": 1,
      "project_name": "Test project 362",
      "project_group_name": "No group",
      "project_group_id": 1,
      "project_group_is_default": true,
      "project_sub_group_name": "No subgroup",
      "project_sub_group_id": 1,
      "project_sub_group_is_default": true,
      "type_name": "TaskType 402",
      "user_name": "Coyote 947",
      "guest_name": null,
      "board_name": "Board 339",
      "board_stage_name": "Board Stage 1035",
      "board_stage_description": null,
      "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,
      "parent_ids": [

      ],
      "opened_parent_ids": [

      ],
      "parents_max_desired_date": null,
      "child_ids": [

      ],
      "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,
      "all_subtasks_time_worked": null,
      "all_subtasks_times_updating": false,
      "all_subtasks_time_total": null,
      "all_subtasks_time_progress": null,
      "current_level": 0,
      "evaluator_ids": null,
      "pending_evaluator_ids": null,
      "approved_evaluator_ids": null,
      "rejected_evaluator_ids": null,
      "custom_fields": {
      },
      "form_id": null,
      "last_activity_at": "2024-11-08T14:11:55-03:00",
      "priority": 1,
      "tag_list": "",
      "tags": [

      ],
      "scheduled_start_time": null,
      "is_scheduled": false,
      "current_evaluator_id": null,
      "assignments": [
        {
          "id": "49537adb9",
          "task_id": 1,
          "assignee_id": "coyote-947",
          "team_id": null,
          "assignee_name": "Coyote 947",
          "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": "2024-11-08T14:11:55-03:00",
          "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-823/coyote-947/mini.png",
          "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-823/coyote-947/regular.png",
          "time_worked_not_persisted": 0
        }
      ]
    }
  }
]

GET

/api/v1.0/task_evaluations

List all task evaluations for a specific task

Request

Route

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

Headers

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

Query Parameters

task_id=1

cURL

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

Response

Simulated Response

Status

Headers

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

Body

[
  {
    "id": 1,
    "state": "pending",
    "happened_at": null,
    "evaluator_id": "coyote-954",
    "evaluator_name": "Coyote 954",
    "evaluator_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-824/coyote-954/mini.png",
    "evaluator_is_deleted": false,
    "task": {
      "id": 1,
      "title": "First task",
      "is_working_on": false,
      "user_id": "coyote-953",
      "guest_id": null,
      "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": "2024-11-08T14:11:58-03:00",
      "start_date": null,
      "desired_start_date": null,
      "current_estimate_seconds": 3600,
      "evaluation_status": null,
      "attachments_count": 0,
      "tags_data": [

      ],
      "client_name": "Test client 396",
      "client_id": 1,
      "project_name": "Test project 365",
      "project_group_name": "No group",
      "project_group_id": 1,
      "project_group_is_default": true,
      "project_sub_group_name": "No subgroup",
      "project_sub_group_id": 1,
      "project_sub_group_is_default": true,
      "type_name": "TaskType 405",
      "user_name": "Coyote 953",
      "guest_name": null,
      "board_name": "Board 342",
      "board_stage_name": "Board Stage 1044",
      "board_stage_description": null,
      "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,
      "parent_ids": [

      ],
      "opened_parent_ids": [

      ],
      "parents_max_desired_date": null,
      "child_ids": [

      ],
      "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,
      "all_subtasks_time_worked": null,
      "all_subtasks_times_updating": false,
      "all_subtasks_time_total": null,
      "all_subtasks_time_progress": null,
      "current_level": 0,
      "evaluator_ids": null,
      "pending_evaluator_ids": null,
      "approved_evaluator_ids": null,
      "rejected_evaluator_ids": null,
      "custom_fields": {
      },
      "form_id": null,
      "last_activity_at": "2024-11-08T14:11:58-03:00",
      "priority": 1,
      "tag_list": "",
      "tags": [

      ],
      "scheduled_start_time": null,
      "is_scheduled": false,
      "current_evaluator_id": null,
      "assignments": [
        {
          "id": "49537adb9",
          "task_id": 1,
          "assignee_id": "coyote-953",
          "team_id": null,
          "assignee_name": "Coyote 953",
          "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": "2024-11-08T14:11:58-03:00",
          "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-824/coyote-953/mini.png",
          "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-824/coyote-953/regular.png",
          "time_worked_not_persisted": 0
        }
      ]
    }
  }
]

GET

/api/v1.0/task_evaluations

List all task evaluations for a specific evaluator

Request

Route

GET /api/v1.0/task_evaluations?evaluator_id=coyote-960

Headers

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

Query Parameters

evaluator_id=coyote-960

cURL

curl -g "https://runrun.it/api/v1.0/task_evaluations?evaluator_id=coyote-960" -X GET \
	-H "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

[
  {
    "id": 2,
    "state": "pending",
    "happened_at": null,
    "evaluator_id": "coyote-960",
    "evaluator_name": "Coyote 960",
    "evaluator_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-825/coyote-960/mini.png",
    "evaluator_is_deleted": false,
    "task": {
      "id": 2,
      "title": "Second task",
      "is_working_on": false,
      "user_id": "coyote-961",
      "guest_id": null,
      "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": 1,
      "created_at": "2024-11-08T14:12:02-03:00",
      "start_date": null,
      "desired_start_date": null,
      "current_estimate_seconds": 3600,
      "evaluation_status": null,
      "attachments_count": 0,
      "tags_data": [

      ],
      "client_name": "Test client 400",
      "client_id": 2,
      "project_name": "Test project 369",
      "project_group_name": "No group",
      "project_group_id": 2,
      "project_group_is_default": true,
      "project_sub_group_name": "No subgroup",
      "project_sub_group_id": 2,
      "project_sub_group_is_default": true,
      "type_name": "TaskType 409",
      "user_name": "Coyote 961",
      "guest_name": null,
      "board_name": "Board 346",
      "board_stage_name": "Board Stage 1056",
      "board_stage_description": null,
      "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,
      "parent_ids": [

      ],
      "opened_parent_ids": [

      ],
      "parents_max_desired_date": null,
      "child_ids": [

      ],
      "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,
      "all_subtasks_time_worked": null,
      "all_subtasks_times_updating": false,
      "all_subtasks_time_total": null,
      "all_subtasks_time_progress": null,
      "current_level": 0,
      "evaluator_ids": null,
      "pending_evaluator_ids": null,
      "approved_evaluator_ids": null,
      "rejected_evaluator_ids": null,
      "custom_fields": {
      },
      "form_id": null,
      "last_activity_at": "2024-11-08T14:12:02-03:00",
      "priority": 1,
      "tag_list": "",
      "tags": [

      ],
      "scheduled_start_time": null,
      "is_scheduled": false,
      "current_evaluator_id": null,
      "assignments": [
        {
          "id": "92a6f5b72",
          "task_id": 2,
          "assignee_id": "coyote-961",
          "team_id": null,
          "assignee_name": "Coyote 961",
          "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": "2024-11-08T14:12:02-03:00",
          "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-825/coyote-961/mini.png",
          "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-825/coyote-961/regular.png",
          "time_worked_not_persisted": 0
        }
      ]
    }
  },
  {
    "id": 1,
    "state": "pending",
    "happened_at": null,
    "evaluator_id": "coyote-960",
    "evaluator_name": "Coyote 960",
    "evaluator_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-825/coyote-960/mini.png",
    "evaluator_is_deleted": false,
    "task": {
      "id": 1,
      "title": "First task",
      "is_working_on": false,
      "user_id": "coyote-959",
      "guest_id": null,
      "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": "2024-11-08T14:12:01-03:00",
      "start_date": null,
      "desired_start_date": null,
      "current_estimate_seconds": 3600,
      "evaluation_status": null,
      "attachments_count": 0,
      "tags_data": [

      ],
      "client_name": "Test client 399",
      "client_id": 1,
      "project_name": "Test project 368",
      "project_group_name": "No group",
      "project_group_id": 1,
      "project_group_is_default": true,
      "project_sub_group_name": "No subgroup",
      "project_sub_group_id": 1,
      "project_sub_group_is_default": true,
      "type_name": "TaskType 408",
      "user_name": "Coyote 959",
      "guest_name": null,
      "board_name": "Board 345",
      "board_stage_name": "Board Stage 1053",
      "board_stage_description": null,
      "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,
      "parent_ids": [

      ],
      "opened_parent_ids": [

      ],
      "parents_max_desired_date": null,
      "child_ids": [

      ],
      "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,
      "all_subtasks_time_worked": null,
      "all_subtasks_times_updating": false,
      "all_subtasks_time_total": null,
      "all_subtasks_time_progress": null,
      "current_level": 0,
      "evaluator_ids": null,
      "pending_evaluator_ids": null,
      "approved_evaluator_ids": null,
      "rejected_evaluator_ids": null,
      "custom_fields": {
      },
      "form_id": null,
      "last_activity_at": "2024-11-08T14:12:01-03:00",
      "priority": 1,
      "tag_list": "",
      "tags": [

      ],
      "scheduled_start_time": null,
      "is_scheduled": false,
      "current_evaluator_id": null,
      "assignments": [
        {
          "id": "49537adb9",
          "task_id": 1,
          "assignee_id": "coyote-959",
          "team_id": null,
          "assignee_name": "Coyote 959",
          "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": "2024-11-08T14:12:01-03:00",
          "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-825/coyote-959/mini.png",
          "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-825/coyote-959/regular.png",
          "time_worked_not_persisted": 0
        }
      ]
    }
  }
]

POST

/api/v1.0/task_evaluations/:id/reset

Reset a task evaluation

Request

Route

POST /api/v1.0/task_evaluations/1/reset

Headers

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

cURL

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

Response

Simulated Response

Status

Headers

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

Body

{
  "id": 1,
  "state": "pending",
  "happened_at": null,
  "evaluator_id": "coyote-966",
  "evaluator_name": "Coyote 966",
  "evaluator_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-826/coyote-966/mini.png",
  "evaluator_is_deleted": false,
  "task": {
    "id": 1,
    "title": "First task",
    "is_working_on": false,
    "user_id": "coyote-965",
    "guest_id": null,
    "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": "2024-11-08T14:12:05-03:00",
    "start_date": null,
    "desired_start_date": null,
    "current_estimate_seconds": 3600,
    "evaluation_status": "pending",
    "attachments_count": 0,
    "tags_data": [

    ],
    "client_name": "Test client 402",
    "client_id": 1,
    "project_name": "Test project 371",
    "project_group_name": "No group",
    "project_group_id": 1,
    "project_group_is_default": true,
    "project_sub_group_name": "No subgroup",
    "project_sub_group_id": 1,
    "project_sub_group_is_default": true,
    "type_name": "TaskType 411",
    "user_name": "Coyote 965",
    "guest_name": null,
    "board_name": "Board 348",
    "board_stage_name": "Board Stage 1062",
    "board_stage_description": null,
    "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,
    "parent_ids": [

    ],
    "opened_parent_ids": [

    ],
    "parents_max_desired_date": null,
    "child_ids": [

    ],
    "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,
    "all_subtasks_time_worked": null,
    "all_subtasks_times_updating": false,
    "all_subtasks_time_total": null,
    "all_subtasks_time_progress": null,
    "current_level": 0,
    "evaluator_ids": [
      "coyote-966"
    ],
    "pending_evaluator_ids": [
      "coyote-966"
    ],
    "approved_evaluator_ids": [

    ],
    "rejected_evaluator_ids": [

    ],
    "custom_fields": {
    },
    "form_id": null,
    "last_activity_at": "2024-11-08T14:12:06-03:00",
    "priority": 1,
    "tag_list": "",
    "tags": [

    ],
    "scheduled_start_time": null,
    "is_scheduled": false,
    "current_evaluator_id": "coyote-966",
    "assignments": [
      {
        "id": "49537adb9",
        "task_id": 1,
        "assignee_id": "coyote-965",
        "team_id": null,
        "assignee_name": "Coyote 965",
        "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": "2024-11-08T14:12:05-03:00",
        "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-826/coyote-965/mini.png",
        "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-826/coyote-965/regular.png",
        "time_worked_not_persisted": 0
      }
    ]
  }
}

DELETE

/api/v1.0/task_evaluations/:id

Destroy a task evaluation

POST

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

Updates the task evaluations

Request

Route

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

Headers

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

Body

{
  "evaluations": [
    {
      "evaluator_id": "coyote-990"
    },
    {
      "evaluator_id": "coyote-991"
    }
  ]
}

cURL

curl "https://runrun.it/api/v1.0/tasks/1/evaluations" -d '{"evaluations":[{"evaluator_id":"coyote-990"},{"evaluator_id":"coyote-991"}]}' -X POST \
	-H "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

{
  "id": 1,
  "title": "Bla 218",
  "is_working_on": false,
  "user_id": "coyote-989",
  "guest_id": null,
  "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": "2024-11-08T14:12:26-03:00",
  "start_date": null,
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "evaluation_status": "pending",
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 404",
  "client_id": 1,
  "project_name": "Test project 373",
  "project_group_name": "No group",
  "project_group_id": 1,
  "project_group_is_default": true,
  "project_sub_group_name": "No subgroup",
  "project_sub_group_id": 1,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 422",
  "user_name": "Coyote 989",
  "guest_name": null,
  "board_name": "Board 355",
  "board_stage_name": "Board Stage 1084",
  "board_stage_description": null,
  "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,
  "parent_ids": [

  ],
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "child_ids": [

  ],
  "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,
  "all_subtasks_time_worked": null,
  "all_subtasks_times_updating": false,
  "all_subtasks_time_total": null,
  "all_subtasks_time_progress": null,
  "current_level": 0,
  "evaluator_ids": [
    "coyote-990",
    "coyote-991"
  ],
  "pending_evaluator_ids": [
    "coyote-990",
    "coyote-991"
  ],
  "approved_evaluator_ids": [

  ],
  "rejected_evaluator_ids": [

  ],
  "custom_fields": {
  },
  "form_id": null,
  "last_activity_at": "2024-11-08T14:12:26-03:00",
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": "coyote-990",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-989",
      "team_id": null,
      "assignee_name": "Coyote 989",
      "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": "2024-11-08T14:12:26-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-845/coyote-989/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-845/coyote-989/regular.png",
      "time_worked_not_persisted": 0
    }
  ]
}

DELETE

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

Destroy all evaluations for this task

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 -g "https://runrun.it/api/v1.0/tasks/1/followers" -X GET \
	-H "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

[
  {
    "id": "coyote-995",
    "name": "Coyote 995",
    "email": "coyote989@acme.foo",
    "avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-847/coyote-995/mini.png",
    "avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-847/coyote-995/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": true,
    "time_zone": "America/Sao_Paulo",
    "position": null,
    "on_vacation": false,
    "birthday": null,
    "phone": null,
    "gender": null,
    "marital_status": null,
    "created_at": "2024-11-08T14:12:30-03:00",
    "in_company_since": null,
    "is_certified": false,
    "is_certified_expert": false,
    "language": "en-US",
    "alt_id": "1ae409f7b3915470a1f16600b69e337d",
    "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,
    "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": [

    ],
    "is_eligible_to_access_reports": false,
    "is_eligible_to_whatsapp": false,
    "theme": "light",
    "task_list_background_image_url": null,
    "skip_time_adjust_on_task_assignment_deliver": false,
    "time_tracking_mode": "manual",
    "preferences": {
      "theme": "light",
      "task_list_background_image_url": null,
      "skip_time_adjust_on_task_assignment_deliver": false,
      "skip_move_task_to_next_board_stage_suggestion": false
    }
  }
]

POST

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

Create a Task Follower

Parameters

Name	Description	type
id	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-997"
}

cURL

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

Response

Simulated Response

Status

Headers

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

Body

{
  "id": "coyote-997",
  "name": "Coyote 997",
  "email": "coyote991@acme.foo",
  "avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-848/coyote-997/mini.png",
  "avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-848/coyote-997/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": "2024-11-08T14:12:32-03:00",
  "in_company_since": null,
  "is_certified": false,
  "is_certified_expert": false,
  "language": "en-US",
  "alt_id": "cfc90eb914c2c959682b92b2730c9625",
  "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,
  "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": [

  ],
  "is_eligible_to_access_reports": false,
  "is_eligible_to_whatsapp": false,
  "theme": "light",
  "task_list_background_image_url": null,
  "skip_time_adjust_on_task_assignment_deliver": false,
  "time_tracking_mode": "manual",
  "preferences": {
    "theme": "light",
    "task_list_background_image_url": null,
    "skip_time_adjust_on_task_assignment_deliver": false,
    "skip_move_task_to_next_board_stage_suggestion": false
  }
}

DELETE

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

Remove a Task Follower

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 -g "https://runrun.it/api/v1.0/tasks/1/followers" -X GET \
	-H "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

[
  {
    "id": "coyote-995",
    "name": "Coyote 995",
    "email": "coyote989@acme.foo",
    "avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-847/coyote-995/mini.png",
    "avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-847/coyote-995/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": true,
    "time_zone": "America/Sao_Paulo",
    "position": null,
    "on_vacation": false,
    "birthday": null,
    "phone": null,
    "gender": null,
    "marital_status": null,
    "created_at": "2024-11-08T14:12:30-03:00",
    "in_company_since": null,
    "is_certified": false,
    "is_certified_expert": false,
    "language": "en-US",
    "alt_id": "1ae409f7b3915470a1f16600b69e337d",
    "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,
    "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": [

    ],
    "is_eligible_to_access_reports": false,
    "is_eligible_to_whatsapp": false,
    "theme": "light",
    "task_list_background_image_url": null,
    "skip_time_adjust_on_task_assignment_deliver": false,
    "time_tracking_mode": "manual",
    "preferences": {
      "theme": "light",
      "task_list_background_image_url": null,
      "skip_time_adjust_on_task_assignment_deliver": false,
      "skip_move_task_to_next_board_stage_suggestion": false
    }
  }
]

POST

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

Create a Task Follower

Parameters

Name	Description	type
id	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-997"
}

cURL

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

Response

Simulated Response

Status

Headers

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

Body

{
  "id": "coyote-997",
  "name": "Coyote 997",
  "email": "coyote991@acme.foo",
  "avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-848/coyote-997/mini.png",
  "avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-848/coyote-997/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": "2024-11-08T14:12:32-03:00",
  "in_company_since": null,
  "is_certified": false,
  "is_certified_expert": false,
  "language": "en-US",
  "alt_id": "cfc90eb914c2c959682b92b2730c9625",
  "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,
  "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": [

  ],
  "is_eligible_to_access_reports": false,
  "is_eligible_to_whatsapp": false,
  "theme": "light",
  "task_list_background_image_url": null,
  "skip_time_adjust_on_task_assignment_deliver": false,
  "time_tracking_mode": "manual",
  "preferences": {
    "theme": "light",
    "task_list_background_image_url": null,
    "skip_time_adjust_on_task_assignment_deliver": false,
    "skip_move_task_to_next_board_stage_suggestion": false
  }
}

DELETE

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

Remove a Task Follower

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 -g "https://runrun.it/api/v1.0/project_templates/1/task_templates" -X GET \
	-H "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

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

    ],
    "created_at": "2024-11-08T14:12:15-03:00",
    "follower_ids": [

    ],
    "is_assigned": true,
    "team_name": null,
    "type_name": "TaskType 415",
    "subtasks_data": [

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

    ],
    "created_at": "2024-11-08T14:12:15-03:00",
    "follower_ids": [

    ],
    "is_assigned": true,
    "team_name": null,
    "type_name": "TaskType 416",
    "subtasks_data": [

    ],
    "responsible_id": null,
    "assignments": [
      {
        "id": "92a6f5b72",
        "task_template_id": 27,
        "assignee_id": "coyote-977",
        "team_id": null,
        "assignee_name": "Coyote 977",
        "team_name": null
      }
    ],
    "workflow_id": null
  }
]

GET

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

Show a Task Template

POST

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

Create a Task Template

Parameters

Name	Description	type
title	Name of task template	string
type_id	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",
    "assignments": [
      {
        "assignee_id": "coyote-979",
        "team_id": 1
      }
    ],
    "subtasks_data": [
      {
        "title": "Subtarefa 1",
        "desired_date": "2021-02-21 10:30 0300",
        "assignments_data": [
          {
            "assignee_id": "coyote-979",
            "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","assignments":[{"assignee_id":"coyote-979","team_id":1}],"subtasks_data":[{"title":"Subtarefa 1","desired_date":"2021-02-21 10:30 0300","assignments_data":[{"assignee_id":"coyote-979","team_id":1}]}]}}' -X POST \
	-H "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

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

  ],
  "created_at": "2024-11-08T14:12:18-03:00",
  "follower_ids": [

  ],
  "is_assigned": true,
  "team_name": null,
  "type_name": "TaskType 418",
  "subtasks_data": [
    {
      "title": "Subtarefa 1",
      "desired_date": "2021-02-21 10:30 0300",
      "assignments_data": [
        {
          "assignee_id": "coyote-979",
          "assignee_name": "Coyote 979",
          "avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-837/coyote-979/mini.png",
          "team_id": 1,
          "team_name": "Test team 53"
        }
      ]
    }
  ],
  "responsible_id": null,
  "assignments": [
    {
      "id": "49537adb9",
      "task_template_id": 1,
      "assignee_id": "coyote-979",
      "team_id": 1,
      "assignee_name": "Coyote 979",
      "team_name": "Test team 53"
    }
  ],
  "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-982",
        "team_id": 1
      }
    ],
    "subtasks_data": [
      {
        "title": "Subtarefa 1",
        "desired_date": "2021-02-21 10:30 0300",
        "assignments_data": [
          {
            "assignee_id": "coyote-981",
            "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-982","team_id":1}],"subtasks_data":[{"title":"Subtarefa 1","desired_date":"2021-02-21 10:30 0300","assignments_data":[{"assignee_id":"coyote-981","team_id":1}]}]}}' -X PUT \
	-H "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

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

  ],
  "created_at": "2024-11-08T14:12:19-03:00",
  "follower_ids": [

  ],
  "is_assigned": true,
  "team_name": null,
  "type_name": "TaskType 419",
  "subtasks_data": [
    {
      "title": "Subtarefa 1",
      "desired_date": "2021-02-21 10:30 0300",
      "assignments_data": [
        {
          "assignee_id": "coyote-981",
          "assignee_name": "Coyote 981",
          "avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-838/coyote-981/mini.png",
          "team_id": 1,
          "team_name": "Test team 54"
        }
      ]
    }
  ],
  "responsible_id": null,
  "assignments": [
    {
      "id": "92a6f5b72",
      "task_template_id": 30,
      "assignee_id": "coyote-982",
      "team_id": 1,
      "assignee_name": "Coyote 982",
      "team_name": "Test team 54"
    }
  ],
  "workflow_id": null
}

DELETE

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

Destroy a Task Template

Task Workflows

GET

/api/v1.0/workflows

Show a Workflow

POST

/api/v1.0/workflows

Create a Workflow

DELETE

/api/v1.0/workflows

Destroy a workflow

Task Workflows

GET

/api/v1.0/workflows

Show a Workflow

POST

/api/v1.0/workflows

Create a Workflow

DELETE

/api/v1.0/workflows

Destroy a workflow

TaskAssignments

DELETE

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

Destroy a task assignment for another user

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 required	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 "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

{
  "id": "49537adb9",
  "task_id": 1,
  "assignee_id": "coyote-867",
  "team_id": null,
  "assignee_name": "Coyote 867",
  "team_name": null,
  "queue_position": 1,
  "priority": 1,
  "current_estimate_seconds": 3600,
  "time_worked": 0,
  "estimated_start_date": null,
  "estimate_updated": false,
  "start_date": "2024-11-08T14:10:58-03:00",
  "close_date": null,
  "is_closed": false,
  "reestimate_count": 0,
  "is_working_on": true,
  "automatic_time_worked_updated_at": "2024-11-08T14:10:58-03:00",
  "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-767/coyote-867/mini.png",
  "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-767/coyote-867/regular.png",
  "time_worked_not_persisted": 0
}

POST

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

Pause a task assignment

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 required	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 "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

{
  "id": "49537adb9",
  "task_id": 1,
  "assignee_id": "coyote-873",
  "team_id": null,
  "assignee_name": "Coyote 873",
  "team_name": null,
  "queue_position": null,
  "priority": null,
  "current_estimate_seconds": 3600,
  "time_worked": 0,
  "estimated_start_date": null,
  "estimate_updated": true,
  "start_date": "2024-11-08T14:11:03-03:00",
  "close_date": "2024-11-08T14:11:03-03:00",
  "is_closed": true,
  "reestimate_count": 0,
  "is_working_on": false,
  "automatic_time_worked_updated_at": "2024-11-08T14:11:02-03:00",
  "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-771/coyote-873/mini.png",
  "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-771/coyote-873/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 "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

{
  "id": "49537adb9",
  "task_id": 1,
  "assignee_id": "coyote-880",
  "team_id": null,
  "assignee_name": "Coyote 880",
  "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": "2024-11-08T14:11:08-03:00",
  "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-775/coyote-880/mini.png",
  "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-775/coyote-880/regular.png",
  "time_worked_not_persisted": 0
}

POST

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

Reposition a Task

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	work seconds

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 "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

{
  "id": "49537adb9",
  "task_id": 1,
  "assignee_id": "coyote-886",
  "team_id": null,
  "assignee_name": "Coyote 886",
  "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": "2024-11-08T14:11:13-03:00",
  "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-779/coyote-886/mini.png",
  "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-779/coyote-886/regular.png",
  "time_worked_not_persisted": 0
}

TaskType

GET

/api/v1.0/task_types

List task types

Parameters

Name	Description	type
sort	Sort by column	string
sort_dir	Sort direction ('asc' or 'desc')	string
search_term	Filter by term	string
filter_id	Filter by an existing filter	integer
is_visible	Filter by visible clients	boolean

Request

Route

GET /api/v1.0/task_types

Headers

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

cURL

curl -g "https://runrun.it/api/v1.0/task_types" -X GET \
	-H "Version: HTTP/1.0" \
	-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 type	integer
name	Type name	string
is_visible	Is the type visible to be chosen? (default: true)	boolean
standard_effort	Default effort to complete a task of this type (default: '00:00')	string
standard_effort_time	Default effort (in seconds) to complete a task of this type	integer
avg_delivery	Average delivery time (in hours) to complete tasks of this type	integer
color	Color of the type in hexadecimal format	string
is_public	True if type is public	boolean
is_default	True if is a system type	boolean
created_at	Datetime of creation	datetime

Status

Headers

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

Body

[
  {
    "id": 1,
    "name": "Task Type",
    "is_visible": true,
    "standard_effort": "01:00",
    "standard_effort_time": 3600,
    "avg_delivery": 0,
    "color": "FFFFFF",
    "is_public": true,
    "is_default": false,
    "created_at": "2024-11-08T14:12:21-03:00"
  }
]

GET

/api/v1.0/task_types/:id

Show a task type

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 -g "https://runrun.it/api/v1.0/task_types/1" -X GET \
	-H "Version: HTTP/1.0" \
	-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 type	integer
name	Type name	string
is_visible	Is the type visible to be chosen? (default: true)	boolean
standard_effort	Default effort to complete a task of this type (default: '00:00')	string
standard_effort_time	Default effort (in seconds) to complete a task of this type	integer
avg_delivery	Average delivery time (in hours) to complete tasks of this type	integer
color	Color of the type in hexadecimal format	string
is_public	True if type is public	boolean
is_default	True if is a system type	boolean
created_at	Datetime of creation	datetime

Status

Headers

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

Body

{
  "id": 1,
  "name": "Task Type",
  "is_visible": true,
  "standard_effort": "01:00",
  "standard_effort_time": 3600,
  "avg_delivery": 0,
  "color": "FFFFFF",
  "is_public": true,
  "is_default": false,
  "created_at": "2024-11-08T14:12:22-03:00"
}

POST

/api/v1.0/task_types

Create a task type

Parameters

Name	Description	type
task_type[name] required	Type name	string
task_type[is_visible]	Is the type visible to be chosen? (default: true)	boolean
task_type[standard_effort]	Default effort to complete a task of this type (default: '00:00')	string
task_type[is_public]	True if type is public	boolean
task_type[color]	Color of the type in hexadecimal format	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": "Task Type",
    "is_visible": true,
    "standard_effort": "03:00",
    "is_public": true,
    "color": "FFFFFF"
  }
}

cURL

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

Response

Simulated Response

Status

Headers

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

Body

{
  "id": 1,
  "name": "Task Type",
  "is_visible": true,
  "standard_effort": "03:00",
  "standard_effort_time": 10800,
  "avg_delivery": 0,
  "color": "FFFFFF",
  "is_public": true,
  "is_default": false,
  "created_at": "2024-11-08T14:12:23-03:00"
}

PUT

/api/v1.0/task_types/:id

Update a task type

Parameters

Name	Description	type
task_type[name]	Type name	string
task_type[is_visible]	Is the type visible to be chosen? (default: true)	boolean
task_type[standard_effort]	Default effort to complete a task of this type (default: '00:00')	string
task_type[is_public]	True if type is public	boolean
task_type[color]	Color of the type in hexadecimal format	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": "Task Type 2",
    "is_visible": false,
    "standard_effort": "04:00",
    "is_public": true,
    "color": "000000"
  }
}

cURL

curl "https://runrun.it/api/v1.0/task_types/1" -d '{"task_type":{"name":"Task Type 2","is_visible":false,"standard_effort":"04:00","is_public":true,"color":"000000"}}' -X PUT \
	-H "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

{
  "id": 1,
  "name": "Task Type 2",
  "is_visible": false,
  "standard_effort": "04:00",
  "standard_effort_time": 14400,
  "avg_delivery": 0,
  "color": "000000",
  "is_public": true,
  "is_default": false,
  "created_at": "2024-11-08T14:12:24-03:00"
}

TaskType

GET

/api/v1.0/task_types

List task types

Parameters

Name	Description	type
sort	Sort by column	string
sort_dir	Sort direction ('asc' or 'desc')	string
search_term	Filter by term	string
filter_id	Filter by an existing filter	integer
is_visible	Filter by visible clients	boolean

Request

Route

GET /api/v1.0/task_types

Headers

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

cURL

curl -g "https://runrun.it/api/v1.0/task_types" -X GET \
	-H "Version: HTTP/1.0" \
	-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 type	integer
name	Type name	string
is_visible	Is the type visible to be chosen? (default: true)	boolean
standard_effort	Default effort to complete a task of this type (default: '00:00')	string
standard_effort_time	Default effort (in seconds) to complete a task of this type	integer
avg_delivery	Average delivery time (in hours) to complete tasks of this type	integer
color	Color of the type in hexadecimal format	string
is_public	True if type is public	boolean
is_default	True if is a system type	boolean
created_at	Datetime of creation	datetime

Status

Headers

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

Body

[
  {
    "id": 1,
    "name": "Task Type",
    "is_visible": true,
    "standard_effort": "01:00",
    "standard_effort_time": 3600,
    "avg_delivery": 0,
    "color": "FFFFFF",
    "is_public": true,
    "is_default": false,
    "created_at": "2024-11-08T14:12:21-03:00"
  }
]

GET

/api/v1.0/task_types/:id

Show a task type

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 -g "https://runrun.it/api/v1.0/task_types/1" -X GET \
	-H "Version: HTTP/1.0" \
	-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 type	integer
name	Type name	string
is_visible	Is the type visible to be chosen? (default: true)	boolean
standard_effort	Default effort to complete a task of this type (default: '00:00')	string
standard_effort_time	Default effort (in seconds) to complete a task of this type	integer
avg_delivery	Average delivery time (in hours) to complete tasks of this type	integer
color	Color of the type in hexadecimal format	string
is_public	True if type is public	boolean
is_default	True if is a system type	boolean
created_at	Datetime of creation	datetime

Status

Headers

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

Body

{
  "id": 1,
  "name": "Task Type",
  "is_visible": true,
  "standard_effort": "01:00",
  "standard_effort_time": 3600,
  "avg_delivery": 0,
  "color": "FFFFFF",
  "is_public": true,
  "is_default": false,
  "created_at": "2024-11-08T14:12:22-03:00"
}

POST

/api/v1.0/task_types

Create a task type

Parameters

Name	Description	type
task_type[name] required	Type name	string
task_type[is_visible]	Is the type visible to be chosen? (default: true)	boolean
task_type[standard_effort]	Default effort to complete a task of this type (default: '00:00')	string
task_type[is_public]	True if type is public	boolean
task_type[color]	Color of the type in hexadecimal format	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": "Task Type",
    "is_visible": true,
    "standard_effort": "03:00",
    "is_public": true,
    "color": "FFFFFF"
  }
}

cURL

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

Response

Simulated Response

Status

Headers

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

Body

{
  "id": 1,
  "name": "Task Type",
  "is_visible": true,
  "standard_effort": "03:00",
  "standard_effort_time": 10800,
  "avg_delivery": 0,
  "color": "FFFFFF",
  "is_public": true,
  "is_default": false,
  "created_at": "2024-11-08T14:12:23-03:00"
}

PUT

/api/v1.0/task_types/:id

Update a task type

Parameters

Name	Description	type
task_type[name]	Type name	string
task_type[is_visible]	Is the type visible to be chosen? (default: true)	boolean
task_type[standard_effort]	Default effort to complete a task of this type (default: '00:00')	string
task_type[is_public]	True if type is public	boolean
task_type[color]	Color of the type in hexadecimal format	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": "Task Type 2",
    "is_visible": false,
    "standard_effort": "04:00",
    "is_public": true,
    "color": "000000"
  }
}

cURL

curl "https://runrun.it/api/v1.0/task_types/1" -d '{"task_type":{"name":"Task Type 2","is_visible":false,"standard_effort":"04:00","is_public":true,"color":"000000"}}' -X PUT \
	-H "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

{
  "id": 1,
  "name": "Task Type 2",
  "is_visible": false,
  "standard_effort": "04:00",
  "standard_effort_time": 14400,
  "avg_delivery": 0,
  "color": "000000",
  "is_public": true,
  "is_default": false,
  "created_at": "2024-11-08T14:12:24-03:00"
}

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

cURL

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

Response

Simulated Response

Status

Headers

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

Body

[
  {
    "id": 2,
    "title": "Improve Task API",
    "is_working_on": false,
    "user_id": "coyote-1017",
    "guest_id": null,
    "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": "2024-11-07T14:12:47-03:00",
    "was_reopened": false,
    "is_closed": true,
    "is_assigned": true,
    "on_going": false,
    "estimate_updated": true,
    "estimated_at": null,
    "queue_position": 2,
    "created_at": "2024-11-08T14:12:47-03:00",
    "start_date": null,
    "desired_start_date": null,
    "current_estimate_seconds": 3600,
    "evaluation_status": null,
    "attachments_count": 0,
    "tags_data": [

    ],
    "client_name": "Test client 416",
    "client_id": 1,
    "project_name": "Test project 385",
    "project_group_name": "No group",
    "project_group_id": 1,
    "project_group_is_default": true,
    "project_sub_group_name": "No subgroup",
    "project_sub_group_id": 1,
    "project_sub_group_is_default": true,
    "type_name": "TaskType 435",
    "user_name": "Coyote 1017",
    "guest_name": null,
    "board_name": "Board 368",
    "board_stage_name": "Board Stage 1123",
    "board_stage_description": null,
    "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,
    "parent_ids": [

    ],
    "opened_parent_ids": [

    ],
    "parents_max_desired_date": null,
    "child_ids": [

    ],
    "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,
    "all_subtasks_time_worked": null,
    "all_subtasks_times_updating": false,
    "all_subtasks_time_total": null,
    "all_subtasks_time_progress": null,
    "current_level": 0,
    "evaluator_ids": null,
    "pending_evaluator_ids": null,
    "approved_evaluator_ids": null,
    "rejected_evaluator_ids": null,
    "custom_fields": {
    },
    "form_id": null,
    "last_activity_at": "2024-11-08T14:12:47-03:00",
    "priority": 2,
    "tag_list": "",
    "tags": [

    ],
    "scheduled_start_time": null,
    "is_scheduled": false,
    "current_evaluator_id": null,
    "uid": 2,
    "responsible_id": "coyote-1015",
    "task_state_id": 4,
    "responsible_name": "Coyote 1015",
    "task_state_name": "Board Stage 1123",
    "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 1123",
    "assignments": [
      {
        "id": "92a6f5b72",
        "task_id": 2,
        "assignee_id": "coyote-1015",
        "team_id": null,
        "assignee_name": "Coyote 1015",
        "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": "2024-11-08T14:12:47-03:00",
        "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-857/coyote-1015/mini.png",
        "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-857/coyote-1015/regular.png",
        "time_worked_not_persisted": 0
      }
    ],
    "follower_ids": [

    ]
  },
  {
    "id": 1,
    "title": "Create Task API",
    "is_working_on": false,
    "user_id": "coyote-1016",
    "guest_id": null,
    "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": "2024-11-06T14:12:46-03:00",
    "was_reopened": false,
    "is_closed": true,
    "is_assigned": true,
    "on_going": false,
    "estimate_updated": true,
    "estimated_at": null,
    "queue_position": 1,
    "created_at": "2024-11-08T14:12:47-03:00",
    "start_date": null,
    "desired_start_date": null,
    "current_estimate_seconds": 3600,
    "evaluation_status": null,
    "attachments_count": 0,
    "tags_data": [

    ],
    "client_name": "Test client 416",
    "client_id": 1,
    "project_name": "Test project 385",
    "project_group_name": "No group",
    "project_group_id": 1,
    "project_group_is_default": true,
    "project_sub_group_name": "No subgroup",
    "project_sub_group_id": 1,
    "project_sub_group_is_default": true,
    "type_name": "TaskType 434",
    "user_name": "Coyote 1016",
    "guest_name": null,
    "board_name": "Board 367",
    "board_stage_name": "Board Stage 1120",
    "board_stage_description": null,
    "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,
    "parent_ids": [

    ],
    "opened_parent_ids": [

    ],
    "parents_max_desired_date": null,
    "child_ids": [

    ],
    "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,
    "all_subtasks_time_worked": null,
    "all_subtasks_times_updating": false,
    "all_subtasks_time_total": null,
    "all_subtasks_time_progress": null,
    "current_level": 0,
    "evaluator_ids": null,
    "pending_evaluator_ids": null,
    "approved_evaluator_ids": null,
    "rejected_evaluator_ids": null,
    "custom_fields": {
    },
    "form_id": null,
    "last_activity_at": "2024-11-08T14:12:47-03:00",
    "priority": 1,
    "tag_list": "",
    "tags": [

    ],
    "scheduled_start_time": null,
    "is_scheduled": false,
    "current_evaluator_id": null,
    "uid": 1,
    "responsible_id": "coyote-1015",
    "task_state_id": 1,
    "responsible_name": "Coyote 1015",
    "task_state_name": "Board Stage 1120",
    "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 1120",
    "assignments": [
      {
        "id": "49537adb9",
        "task_id": 1,
        "assignee_id": "coyote-1015",
        "team_id": null,
        "assignee_name": "Coyote 1015",
        "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": "2024-11-08T14:12:47-03:00",
        "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-857/coyote-1015/mini.png",
        "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-857/coyote-1015/regular.png",
        "time_worked_not_persisted": 0
      }
    ],
    "follower_ids": [

    ]
  }
]

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 -g "https://runrun.it/api/v1.0/tasks/1" -X GET \
	-H "Version: HTTP/1.0" \
	-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
guest_id	ID of guest 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
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
guest_name	Name of guest user who created the task	string
board_name	Name of board	string
board_stage_name	Name of board stage	string
board_stage_description	Description 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
all_subtasks_time_worked	Sum of time (in seconds) worked in all the subtasks from this task	integer
all_subtasks_times_updating	True if is updating subtasks times summations	boolean
all_subtasks_time_total	Sum of total time (in seconds) spent in all the subtasks from this task	integer
all_subtasks_time_progress	Progress of time worked on all the subtasks from this task	float
current_level	Depth level of this task on your tree	integer
evaluator_ids	IDs from evaluators	array
pending_evaluator_ids	IDs from pending evaluators	array
approved_evaluator_ids	IDs from approved evaluators	array
rejected_evaluator_ids	IDs from rejected evaluators	array
custom_fields	Task custom fields	object
form_id	ID of the form whom task was created from	integer
board_stage_data	Data about the task board stage	object
board_stage_elapsed_time	Time spent in seconds in the board stage	integer
board_stage_elapsed_time_updated_at	Datetime of the last update of the attribute board_stage_elapsed_time	datetime
is_board_stage_sla_elapsed_time_overdue	True if board stage SLA elapsed time is overdue	boolean
is_board_stage_sla_last_activity_time_overdue	True if board stage SLA activity time is overdue	boolean
last_activity_at	Datetime of last activity on the task	date_time
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
current_evaluator_id	[Deprecated] Use evaluator_ids	string
fields_metadata	[Deprecated] Board fields metadata	object
board_data	Data about the task board	object
follower_ids	IDs of users following this task	array
workflow_id	ID of associated workflow (if any)	integer

Status

Headers

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

Body

{
  "id": 1,
  "title": "Bla 230",
  "is_working_on": false,
  "user_id": "coyote-1056",
  "guest_id": null,
  "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": "2024-11-08T14:13:11-03:00",
  "start_date": null,
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 429",
  "client_id": 1,
  "project_name": "Test project 398",
  "project_group_name": "No group",
  "project_group_id": 1,
  "project_group_is_default": true,
  "project_sub_group_name": "No subgroup",
  "project_sub_group_id": 1,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 453",
  "user_name": "Coyote 1056",
  "guest_name": null,
  "board_name": "Board 386",
  "board_stage_name": "Board Stage 1177",
  "board_stage_description": null,
  "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,
  "parent_ids": [

  ],
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "child_ids": [

  ],
  "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,
  "all_subtasks_time_worked": null,
  "all_subtasks_times_updating": false,
  "all_subtasks_time_total": null,
  "all_subtasks_time_progress": null,
  "current_level": 0,
  "evaluator_ids": null,
  "pending_evaluator_ids": null,
  "approved_evaluator_ids": null,
  "rejected_evaluator_ids": null,
  "custom_fields": {
  },
  "form_id": null,
  "board_stage_data": {
    "fields": [

    ],
    "use_elapsed_time": false,
    "sla_elapsed_time": null,
    "sla_elapsed_time_unit": null,
    "use_last_activity": false,
    "sla_last_activity_time": null,
    "sla_last_activity_time_unit": null
  },
  "last_activity_at": "2024-11-08T14:13:11-03:00",
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 1,
  "responsible_id": "coyote-1055",
  "task_state_id": 1,
  "responsible_name": "Coyote 1055",
  "task_state_name": "Board Stage 1177",
  "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 1177",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-1055",
      "team_id": null,
      "assignee_name": "Coyote 1055",
      "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": "2024-11-08T14:13:11-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-868/coyote-1055/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-868/coyote-1055/regular.png",
      "time_worked_not_persisted": 0
    }
  ],
  "follower_ids": [

  ],
  "unseen_since": "2024-11-08T14:13:11-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 -g "https://runrun.it/api/v1.0/tasks/1/subtasks" -X GET \
	-H "Version: HTTP/1.0" \
	-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
guest_id	ID of guest 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
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
guest_name	Name of guest user who created the task	string
board_name	Name of board	string
board_stage_name	Name of board stage	string
board_stage_description	Description 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
all_subtasks_time_worked	Sum of time (in seconds) worked in all the subtasks from this task	integer
all_subtasks_times_updating	True if is updating subtasks times summations	boolean
all_subtasks_time_total	Sum of total time (in seconds) spent in all the subtasks from this task	integer
all_subtasks_time_progress	Progress of time worked on all the subtasks from this task	float
current_level	Depth level of this task on your tree	integer
evaluator_ids	IDs from evaluators	array
pending_evaluator_ids	IDs from pending evaluators	array
approved_evaluator_ids	IDs from approved evaluators	array
rejected_evaluator_ids	IDs from rejected evaluators	array
custom_fields	Task custom fields	object
form_id	ID of the form whom task was created from	integer
board_stage_data	Data about the task board stage	object
board_stage_elapsed_time	Time spent in seconds in the board stage	integer
board_stage_elapsed_time_updated_at	Datetime of the last update of the attribute board_stage_elapsed_time	datetime
is_board_stage_sla_elapsed_time_overdue	True if board stage SLA elapsed time is overdue	boolean
is_board_stage_sla_last_activity_time_overdue	True if board stage SLA activity time is overdue	boolean
last_activity_at	Datetime of last activity on the task	date_time
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
current_evaluator_id	[Deprecated] Use evaluator_ids	string
fields_metadata	[Deprecated] Board fields metadata	object
board_data	Data about the task board	object
follower_ids	IDs of users following this task	array
workflow_id	ID of associated workflow (if any)	integer

Status

Headers

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

Body

[
  {
    "id": 2,
    "title": "Subtask",
    "is_working_on": false,
    "user_id": "coyote-1059",
    "guest_id": null,
    "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": "2024-11-08T14:13:13-03:00",
    "start_date": null,
    "desired_start_date": null,
    "current_estimate_seconds": 3600,
    "evaluation_status": null,
    "attachments_count": 0,
    "tags_data": [

    ],
    "client_name": "Test client 431",
    "client_id": 2,
    "project_name": "Test project 400",
    "project_group_name": "No group",
    "project_group_id": 2,
    "project_group_is_default": true,
    "project_sub_group_name": "No subgroup",
    "project_sub_group_id": 2,
    "project_sub_group_is_default": true,
    "type_name": "TaskType 455",
    "user_name": "Coyote 1059",
    "guest_name": null,
    "board_name": "Board 388",
    "board_stage_name": "Board Stage 1183",
    "board_stage_description": null,
    "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,
    "parent_ids": [

    ],
    "opened_parent_ids": [

    ],
    "parents_max_desired_date": null,
    "child_ids": [

    ],
    "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,
    "all_subtasks_time_worked": null,
    "all_subtasks_times_updating": false,
    "all_subtasks_time_total": null,
    "all_subtasks_time_progress": null,
    "current_level": 1,
    "evaluator_ids": null,
    "pending_evaluator_ids": null,
    "approved_evaluator_ids": null,
    "rejected_evaluator_ids": null,
    "custom_fields": {
    },
    "form_id": null,
    "last_activity_at": "2024-11-08T14:13:13-03:00",
    "priority": 2,
    "tag_list": "",
    "tags": [

    ],
    "scheduled_start_time": null,
    "is_scheduled": false,
    "current_evaluator_id": null,
    "uid": 2,
    "responsible_id": "coyote-1057",
    "task_state_id": 4,
    "responsible_name": "Coyote 1057",
    "task_state_name": "Board Stage 1183",
    "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 1183",
    "assignments": [
      {
        "id": "92a6f5b72",
        "task_id": 2,
        "assignee_id": "coyote-1057",
        "team_id": null,
        "assignee_name": "Coyote 1057",
        "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": "2024-11-08T14:13:13-03:00",
        "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-869/coyote-1057/mini.png",
        "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-869/coyote-1057/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]	True if the task is an ongoing task	boolean
task[type_id] required	ID of the task type	integer
task[project_id]	ID of the project the task belongs to	integer
task[desired_start_date]	Desired start date	date_time
task[desired_date]	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 237",
    "desired_date": null,
    "on_going": false,
    "assignments": [
      {
        "assignee_id": "coyote-1070",
        "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 237","desired_date":null,"on_going":false,"assignments":[{"assignee_id":"coyote-1070","team_id":1}],"source":"my_source_value"}}' -X POST \
	-H "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

{
  "id": 1,
  "title": "Bla 237",
  "is_working_on": false,
  "user_id": "coyote-1070",
  "guest_id": null,
  "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": "2024-11-08T14:13:23-03:00",
  "queue_position": 1,
  "created_at": "2024-11-08T14:13:22-03:00",
  "start_date": null,
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 437",
  "client_id": 1,
  "project_name": "Test project 406",
  "project_group_name": "No group",
  "project_group_id": 1,
  "project_group_is_default": true,
  "project_sub_group_name": "No subgroup",
  "project_sub_group_id": 1,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 461",
  "user_name": "Coyote 1070",
  "guest_name": null,
  "board_name": "Board 394",
  "board_stage_name": "Board Stage 1201",
  "board_stage_description": null,
  "team_name": "Test team 55",
  "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,
  "parent_ids": [

  ],
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "child_ids": [

  ],
  "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,
  "all_subtasks_time_worked": null,
  "all_subtasks_times_updating": false,
  "all_subtasks_time_total": null,
  "all_subtasks_time_progress": null,
  "current_level": 0,
  "evaluator_ids": null,
  "pending_evaluator_ids": null,
  "approved_evaluator_ids": null,
  "rejected_evaluator_ids": null,
  "custom_fields": {
  },
  "form_id": null,
  "board_stage_data": {
    "fields": [

    ],
    "use_elapsed_time": false,
    "sla_elapsed_time": null,
    "sla_elapsed_time_unit": null,
    "use_last_activity": false,
    "sla_last_activity_time": null,
    "sla_last_activity_time_unit": null
  },
  "last_activity_at": "2024-11-08T14:13:22-03:00",
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 1,
  "responsible_id": "coyote-1070",
  "task_state_id": 1,
  "responsible_name": "Coyote 1070",
  "task_state_name": "Board Stage 1201",
  "activities_7_days_ago": 0,
  "repetition_rule_id": null,
  "current_worked_time": 0,
  "estimated_delivery_date_updated": true,
  "last_estimated_at": "2024-11-08T14:13:23-03:00",
  "task_tags": [

  ],
  "approved": null,
  "task_status_id": 1,
  "task_status_name": "Board Stage 1201",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-1070",
      "team_id": 1,
      "assignee_name": "Coyote 1070",
      "team_name": "Test team 55",
      "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": "2024-11-08T14:13:23-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-871/coyote-1070/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-871/coyote-1070/regular.png",
      "time_worked_not_persisted": 0
    }
  ],
  "follower_ids": [

  ]
}

PUT

/api/v1.0/tasks/:id

Update task title

Parameters

Name	Description	type
task[title] required	Task title	string

Request

Route

PUT /api/v1.0/tasks/1

Headers

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

Body

{
  "task": {
    "title": "New title"
  }
}

cURL

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

Response

Simulated Response

Status

Headers

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

Body

{
  "id": 1,
  "title": "New title",
  "is_working_on": false,
  "user_id": "coyote-1105",
  "guest_id": null,
  "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": "2024-11-08T14:13:54-03:00",
  "start_date": null,
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 449",
  "client_id": 1,
  "project_name": "Test project 418",
  "project_group_name": "No group",
  "project_group_id": 1,
  "project_group_is_default": true,
  "project_sub_group_name": "No subgroup",
  "project_sub_group_id": 1,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 477",
  "user_name": "Coyote 1105",
  "guest_name": null,
  "board_name": "Board 419",
  "board_stage_name": "Board Stage 1276",
  "board_stage_description": null,
  "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,
  "parent_ids": [

  ],
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "child_ids": [

  ],
  "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,
  "all_subtasks_time_worked": null,
  "all_subtasks_times_updating": false,
  "all_subtasks_time_total": null,
  "all_subtasks_time_progress": null,
  "current_level": 0,
  "evaluator_ids": null,
  "pending_evaluator_ids": null,
  "approved_evaluator_ids": null,
  "rejected_evaluator_ids": null,
  "custom_fields": {
  },
  "form_id": null,
  "board_stage_data": {
    "fields": [

    ],
    "use_elapsed_time": false,
    "sla_elapsed_time": null,
    "sla_elapsed_time_unit": null,
    "use_last_activity": false,
    "sla_last_activity_time": null,
    "sla_last_activity_time_unit": null
  },
  "last_activity_at": "2024-11-08T14:13:54-03:00",
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 1,
  "responsible_id": "coyote-1105",
  "task_state_id": 1,
  "responsible_name": "Coyote 1105",
  "task_state_name": "Board Stage 1276",
  "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 1276",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-1105",
      "team_id": null,
      "assignee_name": "Coyote 1105",
      "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": "2024-11-08T14:13:54-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-893/coyote-1105/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-893/coyote-1105/regular.png",
      "time_worked_not_persisted": 0
    }
  ],
  "follower_ids": [

  ]
}

PUT

/api/v1.0/tasks/:id

Update task desired start date

Parameters

Name	Description	type
task[desired_start_date]	Desired start date	date_time

Request

Route

PUT /api/v1.0/tasks/1

Headers

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

Body

{
  "task": {
    "desired_start_date": "2024-04-17T14:50:30-03:00"
  }
}

cURL

curl "https://runrun.it/api/v1.0/tasks/1" -d '{"task":{"desired_start_date":"2024-04-17T14:50:30-03:00"}}' -X PUT \
	-H "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

{
  "id": 1,
  "title": "Bla 248",
  "is_working_on": false,
  "user_id": "coyote-1107",
  "guest_id": null,
  "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": "2024-04-17T14:50:30-03:00",
  "gantt_bar_end_date": "2024-04-17T23:59:59-03:00",
  "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": "2024-11-08T14:13:56-03:00",
  "start_date": null,
  "desired_start_date": "2024-04-17T14:50:30-03:00",
  "current_estimate_seconds": 3600,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 450",
  "client_id": 1,
  "project_name": "Test project 419",
  "project_group_name": "No group",
  "project_group_id": 1,
  "project_group_is_default": true,
  "project_sub_group_name": "No subgroup",
  "project_sub_group_id": 1,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 478",
  "user_name": "Coyote 1107",
  "guest_name": null,
  "board_name": "Board 420",
  "board_stage_name": "Board Stage 1279",
  "board_stage_description": null,
  "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,
  "parent_ids": [

  ],
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "child_ids": [

  ],
  "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,
  "all_subtasks_time_worked": null,
  "all_subtasks_times_updating": false,
  "all_subtasks_time_total": null,
  "all_subtasks_time_progress": null,
  "current_level": 0,
  "evaluator_ids": null,
  "pending_evaluator_ids": null,
  "approved_evaluator_ids": null,
  "rejected_evaluator_ids": null,
  "custom_fields": {
  },
  "form_id": null,
  "board_stage_data": {
    "fields": [

    ],
    "use_elapsed_time": false,
    "sla_elapsed_time": null,
    "sla_elapsed_time_unit": null,
    "use_last_activity": false,
    "sla_last_activity_time": null,
    "sla_last_activity_time_unit": null
  },
  "last_activity_at": "2024-11-08T14:13:56-03:00",
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": "2024-04-17T14:50:30-03:00",
  "is_scheduled": true,
  "current_evaluator_id": null,
  "uid": 1,
  "responsible_id": "coyote-1107",
  "task_state_id": 1,
  "responsible_name": "Coyote 1107",
  "task_state_name": "Board Stage 1279",
  "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 1279",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-1107",
      "team_id": null,
      "assignee_name": "Coyote 1107",
      "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": "2024-11-08T14:13:56-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-894/coyote-1107/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-894/coyote-1107/regular.png",
      "time_worked_not_persisted": 0
    }
  ],
  "follower_ids": [

  ]
}

PUT

/api/v1.0/tasks/:id

Update task desired date

Parameters

Name	Description	type
task[desired_date]	Desired delivery date	date

Request

Route

PUT /api/v1.0/tasks/1

Headers

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

Body

{
  "task": {
    "desired_date": "2024-04-20T20:23:40-03:00"
  }
}

cURL

curl "https://runrun.it/api/v1.0/tasks/1" -d '{"task":{"desired_date":"2024-04-20T20:23:40-03:00"}}' -X PUT \
	-H "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

{
  "id": 1,
  "title": "Bla 250",
  "is_working_on": false,
  "user_id": "coyote-1111",
  "guest_id": null,
  "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": "2024-04-20",
  "desired_date_with_time": "2024-04-20T20:23:40-03:00",
  "estimated_start_date": null,
  "estimated_delivery_date": null,
  "gantt_bar_start_date": "2024-04-20T00:00:00-03:00",
  "gantt_bar_end_date": "2024-04-20T20:23:40-03:00",
  "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": "2024-11-08T14:14:00-03:00",
  "start_date": null,
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 452",
  "client_id": 1,
  "project_name": "Test project 421",
  "project_group_name": "No group",
  "project_group_id": 1,
  "project_group_is_default": true,
  "project_sub_group_name": "No subgroup",
  "project_sub_group_id": 1,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 480",
  "user_name": "Coyote 1111",
  "guest_name": null,
  "board_name": "Board 422",
  "board_stage_name": "Board Stage 1285",
  "board_stage_description": null,
  "team_name": null,
  "type_color": "FFFFFF",
  "state": "queued",
  "overdue": "hard_overdue",
  "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,
  "parent_ids": [

  ],
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "child_ids": [

  ],
  "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,
  "all_subtasks_time_worked": null,
  "all_subtasks_times_updating": false,
  "all_subtasks_time_total": null,
  "all_subtasks_time_progress": null,
  "current_level": 0,
  "evaluator_ids": null,
  "pending_evaluator_ids": null,
  "approved_evaluator_ids": null,
  "rejected_evaluator_ids": null,
  "custom_fields": {
  },
  "form_id": null,
  "board_stage_data": {
    "fields": [

    ],
    "use_elapsed_time": false,
    "sla_elapsed_time": null,
    "sla_elapsed_time_unit": null,
    "use_last_activity": false,
    "sla_last_activity_time": null,
    "sla_last_activity_time_unit": null
  },
  "last_activity_at": "2024-11-08T14:14:00-03:00",
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 1,
  "responsible_id": "coyote-1111",
  "task_state_id": 1,
  "responsible_name": "Coyote 1111",
  "task_state_name": "Board Stage 1285",
  "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 1285",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-1111",
      "team_id": null,
      "assignee_name": "Coyote 1111",
      "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": "2024-11-08T14:14:00-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-896/coyote-1111/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-896/coyote-1111/regular.png",
      "time_worked_not_persisted": 0
    }
  ],
  "follower_ids": [

  ]
}

PUT

/api/v1.0/tasks/:id

Update task tags

Parameters

Name	Description	type
task[tags_data]	Tags for task	array

Request

Route

PUT /api/v1.0/tasks/1

Headers

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

Body

{
  "task": {
    "tags_data": [
      {
        "name": "tag a",
        "color": "ffffff"
      },
      {
        "name": "tag b",
        "color": "000000"
      }
    ]
  }
}

cURL

curl "https://runrun.it/api/v1.0/tasks/1" -d '{"task":{"tags_data":[{"name":"tag a","color":"ffffff"},{"name":"tag b","color":"000000"}]}}' -X PUT \
	-H "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

{
  "id": 1,
  "title": "Bla 252",
  "is_working_on": false,
  "user_id": "coyote-1115",
  "guest_id": null,
  "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": "2024-11-08T14:14:03-03:00",
  "start_date": null,
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [
    {
      "name": "tag a",
      "color": "ffffff"
    },
    {
      "name": "tag b",
      "color": "000000"
    }
  ],
  "client_name": "Test client 454",
  "client_id": 1,
  "project_name": "Test project 423",
  "project_group_name": "No group",
  "project_group_id": 1,
  "project_group_is_default": true,
  "project_sub_group_name": "No subgroup",
  "project_sub_group_id": 1,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 482",
  "user_name": "Coyote 1115",
  "guest_name": null,
  "board_name": "Board 424",
  "board_stage_name": "Board Stage 1291",
  "board_stage_description": null,
  "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,
  "parent_ids": [

  ],
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "child_ids": [

  ],
  "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,
  "all_subtasks_time_worked": null,
  "all_subtasks_times_updating": false,
  "all_subtasks_time_total": null,
  "all_subtasks_time_progress": null,
  "current_level": 0,
  "evaluator_ids": null,
  "pending_evaluator_ids": null,
  "approved_evaluator_ids": null,
  "rejected_evaluator_ids": null,
  "custom_fields": {
  },
  "form_id": null,
  "board_stage_data": {
    "fields": [

    ],
    "use_elapsed_time": false,
    "sla_elapsed_time": null,
    "sla_elapsed_time_unit": null,
    "use_last_activity": false,
    "sla_last_activity_time": null,
    "sla_last_activity_time_unit": null
  },
  "last_activity_at": "2024-11-08T14:14:04-03:00",
  "priority": 1,
  "tag_list": "tag a, tag b",
  "tags": [
    "tag a",
    "tag b"
  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 1,
  "responsible_id": "coyote-1115",
  "task_state_id": 1,
  "responsible_name": "Coyote 1115",
  "task_state_name": "Board Stage 1291",
  "activities_7_days_ago": 0,
  "repetition_rule_id": null,
  "current_worked_time": 0,
  "estimated_delivery_date_updated": false,
  "last_estimated_at": null,
  "task_tags": [
    "tag a",
    "tag b"
  ],
  "approved": null,
  "task_status_id": 1,
  "task_status_name": "Board Stage 1291",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-1115",
      "team_id": null,
      "assignee_name": "Coyote 1115",
      "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": "2024-11-08T14:14:03-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-898/coyote-1115/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-898/coyote-1115/regular.png",
      "time_worked_not_persisted": 0
    }
  ],
  "follower_ids": [

  ]
}

PUT

/api/v1.0/tasks/:id

Update task points

Parameters

Name	Description	type
task[points]		integer

Request

Route

PUT /api/v1.0/tasks/1

Headers

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

Body

{
  "task": {
    "points": 8
  }
}

cURL

curl "https://runrun.it/api/v1.0/tasks/1" -d '{"task":{"points":8}}' -X PUT \
	-H "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

{
  "id": 1,
  "title": "Bla 257",
  "is_working_on": false,
  "user_id": "coyote-1125",
  "guest_id": null,
  "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": "2024-11-08T14:14:13-03:00",
  "start_date": null,
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 459",
  "client_id": 1,
  "project_name": "Test project 428",
  "project_group_name": "No group",
  "project_group_id": 1,
  "project_group_is_default": true,
  "project_sub_group_name": "No subgroup",
  "project_sub_group_id": 1,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 487",
  "user_name": "Coyote 1125",
  "guest_name": null,
  "board_name": "Board 429",
  "board_stage_name": "Board Stage 1306",
  "board_stage_description": null,
  "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": 8,
  "reestimate_count": 0,
  "parent_ids": [

  ],
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "child_ids": [

  ],
  "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,
  "all_subtasks_time_worked": null,
  "all_subtasks_times_updating": false,
  "all_subtasks_time_total": null,
  "all_subtasks_time_progress": null,
  "current_level": 0,
  "evaluator_ids": null,
  "pending_evaluator_ids": null,
  "approved_evaluator_ids": null,
  "rejected_evaluator_ids": null,
  "custom_fields": {
  },
  "form_id": null,
  "board_stage_data": {
    "fields": [

    ],
    "use_elapsed_time": false,
    "sla_elapsed_time": null,
    "sla_elapsed_time_unit": null,
    "use_last_activity": false,
    "sla_last_activity_time": null,
    "sla_last_activity_time_unit": null
  },
  "last_activity_at": "2024-11-08T14:14:13-03:00",
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 1,
  "responsible_id": "coyote-1125",
  "task_state_id": 1,
  "responsible_name": "Coyote 1125",
  "task_state_name": "Board Stage 1306",
  "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 1306",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-1125",
      "team_id": null,
      "assignee_name": "Coyote 1125",
      "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": "2024-11-08T14:14:13-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-903/coyote-1125/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-903/coyote-1125/regular.png",
      "time_worked_not_persisted": 0
    }
  ],
  "follower_ids": [

  ]
}

PUT

/api/v1.0/tasks/:id

Update task custom fields

Custom fields are identified by a "custom_" prefix followed by a number

To determine which custom fields can be filled in a task, you need to access the endpoint GET api/v1.0/tasks/:task_id/fields

The options of the fields of type 'single_option' and 'multiple_options' can be accessed in the endpoint GET api/v1.0/fields/:field_id/options

Parameters

Name	Description	type
task[custom_fields]	Task custom fields	object

Request

Route

PUT /api/v1.0/tasks/1

Headers

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

Body

{
  "task": {
    "custom_fields": {
      "custom_3": "new_text",
      "custom_4": 45,
      "custom_5": 30.23,
      "custom_6": 8,
      "custom_7": "2024-11-15",
      "custom_8": "2024-11-15T21:12:43-03:00",
      "custom_1": {
        "id": "2",
        "label": "Option 2"
      },
      "custom_2": [
        {
          "id": "3",
          "label": "Option A"
        },
        {
          "id": "4",
          "label": "Option B"
        }
      ]
    }
  }
}

cURL

curl "https://runrun.it/api/v1.0/tasks/1" -d '{"task":{"custom_fields":{"custom_3":"new_text","custom_4":45,"custom_5":30.23,"custom_6":8,"custom_7":"2024-11-15","custom_8":"2024-11-15T21:12:43-03:00","custom_1":{"id":"2","label":"Option 2"},"custom_2":[{"id":"3","label":"Option A"},{"id":"4","label":"Option B"}]}}}' -X PUT \
	-H "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

{
  "id": 1,
  "title": "Bla 260",
  "is_working_on": false,
  "user_id": "coyote-1131",
  "guest_id": null,
  "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": "2024-11-08T14:14:18-03:00",
  "start_date": null,
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 462",
  "client_id": 1,
  "project_name": "Test project 431",
  "project_group_name": "No group",
  "project_group_id": 1,
  "project_group_is_default": true,
  "project_sub_group_name": "No subgroup",
  "project_sub_group_id": 1,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 490",
  "user_name": "Coyote 1131",
  "guest_name": null,
  "board_name": "Board 432",
  "board_stage_name": "Board Stage 1315",
  "board_stage_description": null,
  "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,
  "parent_ids": [

  ],
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "child_ids": [

  ],
  "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,
  "all_subtasks_time_worked": null,
  "all_subtasks_times_updating": false,
  "all_subtasks_time_total": null,
  "all_subtasks_time_progress": null,
  "current_level": 0,
  "evaluator_ids": null,
  "pending_evaluator_ids": null,
  "approved_evaluator_ids": null,
  "rejected_evaluator_ids": null,
  "custom_fields": {
    "custom_1": {
      "id": "2",
      "label": "Option 2"
    },
    "custom_2": [
      {
        "id": "3",
        "label": "Option A"
      },
      {
        "id": "4",
        "label": "Option B"
      }
    ],
    "custom_3": "new_text",
    "custom_4": 45,
    "custom_5": 30.23,
    "custom_6": 8,
    "custom_7": "2024-11-15",
    "custom_8": "2024-11-15T21:12:43-03:00"
  },
  "form_id": null,
  "board_stage_data": {
    "fields": [

    ],
    "use_elapsed_time": false,
    "sla_elapsed_time": null,
    "sla_elapsed_time_unit": null,
    "use_last_activity": false,
    "sla_last_activity_time": null,
    "sla_last_activity_time_unit": null
  },
  "last_activity_at": "2024-11-08T14:14:19-03:00",
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 1,
  "responsible_id": "coyote-1131",
  "task_state_id": 1,
  "responsible_name": "Coyote 1131",
  "task_state_name": "Board Stage 1315",
  "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 1315",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-1131",
      "team_id": null,
      "assignee_name": "Coyote 1131",
      "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": "2024-11-08T14:14:18-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-906/coyote-1131/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-906/coyote-1131/regular.png",
      "time_worked_not_persisted": 0
    }
  ],
  "follower_ids": [

  ]
}

DELETE

/api/v1.0/tasks/:id

Destroy a Task

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 required	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 "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

{
  "id": 1,
  "title": "Bla 269",
  "is_working_on": true,
  "user_id": "coyote-1151",
  "guest_id": null,
  "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": "2024-11-08T14:14:39-03:00",
  "start_date": "2024-11-08T14:14:39-03:00",
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 471",
  "client_id": 1,
  "project_name": "Test project 440",
  "project_group_name": "No group",
  "project_group_id": 1,
  "project_group_is_default": true,
  "project_sub_group_name": "No subgroup",
  "project_sub_group_id": 1,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 499",
  "user_name": "Coyote 1151",
  "guest_name": null,
  "board_name": "Board 441",
  "board_stage_name": "Board Stage 1342",
  "board_stage_description": null,
  "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,
  "parent_ids": [

  ],
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "child_ids": [

  ],
  "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,
  "all_subtasks_time_worked": null,
  "all_subtasks_times_updating": false,
  "all_subtasks_time_total": null,
  "all_subtasks_time_progress": null,
  "current_level": 0,
  "evaluator_ids": null,
  "pending_evaluator_ids": null,
  "approved_evaluator_ids": null,
  "rejected_evaluator_ids": null,
  "custom_fields": {
  },
  "form_id": null,
  "board_stage_data": {
    "fields": [

    ],
    "use_elapsed_time": false,
    "sla_elapsed_time": null,
    "sla_elapsed_time_unit": null,
    "use_last_activity": false,
    "sla_last_activity_time": null,
    "sla_last_activity_time_unit": null
  },
  "last_activity_at": "2024-11-08T14:14:39-03:00",
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 1,
  "responsible_id": "coyote-1150",
  "task_state_id": 1,
  "responsible_name": "Coyote 1150",
  "task_state_name": "Board Stage 1342",
  "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 1342",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-1150",
      "team_id": null,
      "assignee_name": "Coyote 1150",
      "team_name": null,
      "queue_position": 1,
      "priority": 1,
      "current_estimate_seconds": 3600,
      "time_worked": 0,
      "estimated_start_date": null,
      "estimate_updated": false,
      "start_date": "2024-11-08T14:14:39-03:00",
      "close_date": null,
      "is_closed": false,
      "reestimate_count": 0,
      "is_working_on": true,
      "automatic_time_worked_updated_at": "2024-11-08T14:14:39-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-915/coyote-1150/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-915/coyote-1150/regular.png",
      "time_worked_not_persisted": 0
    }
  ],
  "follower_ids": [

  ]
}

POST

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

Create assignment and play Task

Parameters

Name	Description	type
id required	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 "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

{
  "id": 1,
  "title": "Bla 270",
  "is_working_on": true,
  "user_id": "coyote-1153",
  "guest_id": null,
  "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": "2024-11-08T14:14:41-03:00",
  "start_date": "2024-11-08T14:14:41-03:00",
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 472",
  "client_id": 1,
  "project_name": "Test project 441",
  "project_group_name": "No group",
  "project_group_id": 1,
  "project_group_is_default": true,
  "project_sub_group_name": "No subgroup",
  "project_sub_group_id": 1,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 500",
  "user_name": "Coyote 1153",
  "guest_name": null,
  "board_name": "Board 442",
  "board_stage_name": "Board Stage 1345",
  "board_stage_description": null,
  "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,
  "parent_ids": [

  ],
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "child_ids": [

  ],
  "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,
  "all_subtasks_time_worked": null,
  "all_subtasks_times_updating": false,
  "all_subtasks_time_total": null,
  "all_subtasks_time_progress": null,
  "current_level": 0,
  "evaluator_ids": null,
  "pending_evaluator_ids": null,
  "approved_evaluator_ids": null,
  "rejected_evaluator_ids": null,
  "custom_fields": {
  },
  "form_id": null,
  "board_stage_data": {
    "fields": [

    ],
    "use_elapsed_time": false,
    "sla_elapsed_time": null,
    "sla_elapsed_time_unit": null,
    "use_last_activity": false,
    "sla_last_activity_time": null,
    "sla_last_activity_time_unit": null
  },
  "last_activity_at": "2024-11-08T14:14:41-03:00",
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 1,
  "responsible_id": "coyote-1152",
  "task_state_id": 1,
  "responsible_name": "Coyote 1152",
  "task_state_name": "Board Stage 1345",
  "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 1345",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-1152",
      "team_id": null,
      "assignee_name": "Coyote 1152",
      "team_name": null,
      "queue_position": 1,
      "priority": 1,
      "current_estimate_seconds": 3600,
      "time_worked": 0,
      "estimated_start_date": null,
      "estimate_updated": false,
      "start_date": "2024-11-08T14:14:41-03:00",
      "close_date": null,
      "is_closed": false,
      "reestimate_count": 0,
      "is_working_on": true,
      "automatic_time_worked_updated_at": "2024-11-08T14:14:41-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-916/coyote-1152/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-916/coyote-1152/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 required	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 "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

{
  "id": 1,
  "title": "Bla 271",
  "is_working_on": false,
  "user_id": "coyote-1155",
  "guest_id": null,
  "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": "2024-11-08T14:14:43-03:00",
  "start_date": "2024-11-08T14:14:44-03:00",
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 473",
  "client_id": 1,
  "project_name": "Test project 442",
  "project_group_name": "No group",
  "project_group_id": 1,
  "project_group_is_default": true,
  "project_sub_group_name": "No subgroup",
  "project_sub_group_id": 1,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 501",
  "user_name": "Coyote 1155",
  "guest_name": null,
  "board_name": "Board 443",
  "board_stage_name": "Board Stage 1348",
  "board_stage_description": null,
  "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,
  "parent_ids": [

  ],
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "child_ids": [

  ],
  "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,
  "all_subtasks_time_worked": null,
  "all_subtasks_times_updating": false,
  "all_subtasks_time_total": null,
  "all_subtasks_time_progress": null,
  "current_level": 0,
  "evaluator_ids": null,
  "pending_evaluator_ids": null,
  "approved_evaluator_ids": null,
  "rejected_evaluator_ids": null,
  "custom_fields": {
  },
  "form_id": null,
  "board_stage_data": {
    "fields": [

    ],
    "use_elapsed_time": false,
    "sla_elapsed_time": null,
    "sla_elapsed_time_unit": null,
    "use_last_activity": false,
    "sla_last_activity_time": null,
    "sla_last_activity_time_unit": null
  },
  "last_activity_at": "2024-11-08T14:14:44-03:00",
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 1,
  "responsible_id": "coyote-1155",
  "task_state_id": 1,
  "responsible_name": "Coyote 1155",
  "task_state_name": "Board Stage 1348",
  "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 1348",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-1154",
      "team_id": null,
      "assignee_name": "Coyote 1154",
      "team_name": null,
      "queue_position": 1,
      "priority": 1,
      "current_estimate_seconds": 3600,
      "time_worked": 0,
      "estimated_start_date": "2024-11-08T14:14:44-03:00",
      "estimate_updated": false,
      "start_date": "2024-11-08T14:14:44-03:00",
      "close_date": null,
      "is_closed": false,
      "reestimate_count": 0,
      "is_working_on": false,
      "automatic_time_worked_updated_at": "2024-11-08T14:14:44-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-917/coyote-1154/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-917/coyote-1154/regular.png",
      "time_worked_not_persisted": 0
    }
  ],
  "follower_ids": [

  ]
}

POST

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

Change a Task board to another

Parameters

Name	Description	type
id required	Task ID	integer
board_id required	ID of the board the task belongs to	integer

Request

Route

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

Headers

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

Body

{
  "board_id": 2
}

cURL

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

Response

Simulated Response

Status

Headers

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

Body

{
  "id": 1,
  "title": "Bla 274",
  "is_working_on": false,
  "user_id": "coyote-1160",
  "guest_id": null,
  "type_id": 1,
  "project_id": 1,
  "team_id": null,
  "board_id": 2,
  "board_stage_id": 3,
  "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": "2024-11-08T14:14:49-03:00",
  "queue_position": 1,
  "created_at": "2024-11-08T14:14:49-03:00",
  "start_date": null,
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 476",
  "client_id": 1,
  "project_name": "Test project 445",
  "project_group_name": "No group",
  "project_group_id": 1,
  "project_group_is_default": true,
  "project_sub_group_name": "No subgroup",
  "project_sub_group_id": 1,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 504",
  "user_name": "Coyote 1160",
  "guest_name": null,
  "board_name": "Board 447",
  "board_stage_name": "Board Stage 1359",
  "board_stage_description": null,
  "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,
  "parent_ids": [

  ],
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "child_ids": [

  ],
  "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,
  "all_subtasks_time_worked": null,
  "all_subtasks_times_updating": false,
  "all_subtasks_time_total": null,
  "all_subtasks_time_progress": null,
  "current_level": 0,
  "evaluator_ids": null,
  "pending_evaluator_ids": null,
  "approved_evaluator_ids": null,
  "rejected_evaluator_ids": null,
  "custom_fields": {
  },
  "form_id": null,
  "board_stage_data": {
    "fields": [

    ],
    "use_elapsed_time": false,
    "sla_elapsed_time": null,
    "sla_elapsed_time_unit": null,
    "use_last_activity": false,
    "sla_last_activity_time": null,
    "sla_last_activity_time_unit": null
  },
  "last_activity_at": "2024-11-08T14:14:49-03:00",
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 1,
  "responsible_id": "coyote-1159",
  "task_state_id": 3,
  "responsible_name": "Coyote 1159",
  "task_state_name": "Board Stage 1359",
  "activities_7_days_ago": 0,
  "repetition_rule_id": null,
  "current_worked_time": 0,
  "estimated_delivery_date_updated": true,
  "last_estimated_at": "2024-11-08T14:14:49-03:00",
  "task_tags": [

  ],
  "approved": null,
  "task_status_id": 3,
  "task_status_name": "Board Stage 1359",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-1159",
      "team_id": null,
      "assignee_name": "Coyote 1159",
      "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": "2024-11-08T14:14:49-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-919/coyote-1159/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-919/coyote-1159/regular.png",
      "time_worked_not_persisted": 0
    }
  ],
  "follower_ids": [

  ]
}

POST

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

Change the project from task to another

Parameters

Name	Description	type
id required	Task ID	integer
project_id	ID of the project the task belongs to	integer

Request

Route

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

Headers

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

Body

{
  "project_id": 1
}

cURL

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

Response

Simulated Response

Status

Headers

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

Body

{
  "id": 1,
  "title": "Bla 275",
  "is_working_on": false,
  "user_id": "coyote-1162",
  "guest_id": null,
  "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": "2024-11-08T14:14:51-03:00",
  "start_date": null,
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 477",
  "client_id": 1,
  "project_name": "Test project 446",
  "project_group_name": "No group",
  "project_group_id": 1,
  "project_group_is_default": true,
  "project_sub_group_name": "No subgroup",
  "project_sub_group_id": 1,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 505",
  "user_name": "Coyote 1162",
  "guest_name": null,
  "board_name": "Board 448",
  "board_stage_name": "Board Stage 1361",
  "board_stage_description": null,
  "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,
  "parent_ids": [

  ],
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "child_ids": [

  ],
  "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,
  "all_subtasks_time_worked": null,
  "all_subtasks_times_updating": false,
  "all_subtasks_time_total": null,
  "all_subtasks_time_progress": null,
  "current_level": 0,
  "evaluator_ids": null,
  "pending_evaluator_ids": null,
  "approved_evaluator_ids": null,
  "rejected_evaluator_ids": null,
  "custom_fields": {
  },
  "form_id": null,
  "board_stage_data": {
    "fields": [

    ],
    "use_elapsed_time": false,
    "sla_elapsed_time": null,
    "sla_elapsed_time_unit": null,
    "use_last_activity": false,
    "sla_last_activity_time": null,
    "sla_last_activity_time_unit": null
  },
  "last_activity_at": "2024-11-08T14:14:51-03:00",
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 1,
  "responsible_id": "coyote-1161",
  "task_state_id": 1,
  "responsible_name": "Coyote 1161",
  "task_state_name": "Board Stage 1361",
  "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 1361",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-1161",
      "team_id": null,
      "assignee_name": "Coyote 1161",
      "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": "2024-11-08T14:14:51-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-920/coyote-1161/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-920/coyote-1161/regular.png",
      "time_worked_not_persisted": 0
    }
  ],
  "follower_ids": [

  ]
}

POST

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

Change the type from task to another

Parameters

Name	Description	type
id required	Task ID	integer
type_id required	ID of the task type	integer

Request

Route

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

Headers

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

Body

{
  "type_id": 1
}

cURL

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

Response

Simulated Response

Status

Headers

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

Body

{
  "id": 1,
  "title": "Bla 277",
  "is_working_on": false,
  "user_id": "coyote-1166",
  "guest_id": null,
  "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": true,
  "estimated_at": "2024-11-08T14:14:55-03:00",
  "queue_position": 1,
  "created_at": "2024-11-08T14:14:55-03:00",
  "start_date": null,
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 479",
  "client_id": 1,
  "project_name": "Test project 449",
  "project_group_name": "No group",
  "project_group_id": 1,
  "project_group_is_default": true,
  "project_sub_group_name": "No subgroup",
  "project_sub_group_id": 1,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 507",
  "user_name": "Coyote 1166",
  "guest_name": null,
  "board_name": "Board 450",
  "board_stage_name": "Board Stage 1367",
  "board_stage_description": null,
  "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,
  "parent_ids": [

  ],
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "child_ids": [

  ],
  "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,
  "all_subtasks_time_worked": null,
  "all_subtasks_times_updating": false,
  "all_subtasks_time_total": null,
  "all_subtasks_time_progress": null,
  "current_level": 0,
  "evaluator_ids": null,
  "pending_evaluator_ids": null,
  "approved_evaluator_ids": null,
  "rejected_evaluator_ids": null,
  "custom_fields": {
  },
  "form_id": null,
  "board_stage_data": {
    "fields": [

    ],
    "use_elapsed_time": false,
    "sla_elapsed_time": null,
    "sla_elapsed_time_unit": null,
    "use_last_activity": false,
    "sla_last_activity_time": null,
    "sla_last_activity_time_unit": null
  },
  "last_activity_at": "2024-11-08T14:14:55-03:00",
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 1,
  "responsible_id": "coyote-1166",
  "task_state_id": 1,
  "responsible_name": "Coyote 1166",
  "task_state_name": "Board Stage 1367",
  "activities_7_days_ago": 0,
  "repetition_rule_id": null,
  "current_worked_time": 0,
  "estimated_delivery_date_updated": true,
  "last_estimated_at": "2024-11-08T14:14:55-03:00",
  "task_tags": [

  ],
  "approved": null,
  "task_status_id": 1,
  "task_status_name": "Board Stage 1367",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-1166",
      "team_id": null,
      "assignee_name": "Coyote 1166",
      "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": "2024-11-08T14:14:55-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-922/coyote-1166/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-922/coyote-1166/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 required	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 "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

{
  "id": 1,
  "title": "Bla 280",
  "is_working_on": false,
  "user_id": "coyote-1172",
  "guest_id": null,
  "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": "2024-11-08T14:15:00-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": "2024-11-08T14:15:00-03:00",
  "start_date": "2024-11-08T14:15:00-03:00",
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 482",
  "client_id": 1,
  "project_name": "Test project 452",
  "project_group_name": "No group",
  "project_group_id": 1,
  "project_group_is_default": true,
  "project_sub_group_name": "No subgroup",
  "project_sub_group_id": 1,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 511",
  "user_name": "Coyote 1172",
  "guest_name": null,
  "board_name": "Board 453",
  "board_stage_name": "Board Stage 1378",
  "board_stage_description": null,
  "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,
  "parent_ids": [

  ],
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "child_ids": [

  ],
  "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,
  "all_subtasks_time_worked": null,
  "all_subtasks_times_updating": false,
  "all_subtasks_time_total": null,
  "all_subtasks_time_progress": null,
  "current_level": 0,
  "evaluator_ids": null,
  "pending_evaluator_ids": null,
  "approved_evaluator_ids": null,
  "rejected_evaluator_ids": null,
  "custom_fields": {
  },
  "form_id": null,
  "board_stage_data": {
    "fields": [

    ],
    "use_elapsed_time": false,
    "sla_elapsed_time": null,
    "sla_elapsed_time_unit": null,
    "use_last_activity": false,
    "sla_last_activity_time": null,
    "sla_last_activity_time_unit": null
  },
  "last_activity_at": "2024-11-08T14:15:00-03:00",
  "priority": null,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 1,
  "responsible_id": "coyote-1171",
  "task_state_id": 3,
  "responsible_name": "Coyote 1171",
  "task_state_name": "Board Stage 1378",
  "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 1378",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-1171",
      "team_id": null,
      "assignee_name": "Coyote 1171",
      "team_name": null,
      "queue_position": null,
      "priority": null,
      "current_estimate_seconds": 3600,
      "time_worked": 0,
      "estimated_start_date": null,
      "estimate_updated": true,
      "start_date": "2024-11-08T14:15:00-03:00",
      "close_date": "2024-11-08T14:15:00-03:00",
      "is_closed": true,
      "reestimate_count": 0,
      "is_working_on": false,
      "automatic_time_worked_updated_at": "2024-11-08T14:15:00-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-925/coyote-1171/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-925/coyote-1171/regular.png",
      "time_worked_not_persisted": 0
    }
  ],
  "follower_ids": [

  ]
}

POST

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

Reopen a Task

Reopen a closed task.

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 "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

{
  "id": 1,
  "title": "Bla 282",
  "is_working_on": false,
  "user_id": "coyote-1178",
  "guest_id": null,
  "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": "2024-11-08T14:15:05-03:00",
  "queue_position": 1,
  "created_at": "2024-11-08T14:15:04-03:00",
  "start_date": "2024-11-08T14:15:04-03:00",
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 484",
  "client_id": 1,
  "project_name": "Test project 454",
  "project_group_name": "No group",
  "project_group_id": 1,
  "project_group_is_default": true,
  "project_sub_group_name": "No subgroup",
  "project_sub_group_id": 1,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 513",
  "user_name": "Coyote 1178",
  "guest_name": null,
  "board_name": "Board 455",
  "board_stage_name": "Board Stage 1383",
  "board_stage_description": null,
  "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,
  "parent_ids": [

  ],
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "child_ids": [

  ],
  "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,
  "all_subtasks_time_worked": null,
  "all_subtasks_times_updating": false,
  "all_subtasks_time_total": null,
  "all_subtasks_time_progress": null,
  "current_level": 0,
  "evaluator_ids": null,
  "pending_evaluator_ids": null,
  "approved_evaluator_ids": null,
  "rejected_evaluator_ids": null,
  "custom_fields": {
  },
  "form_id": null,
  "board_stage_data": {
    "fields": [

    ],
    "use_elapsed_time": false,
    "sla_elapsed_time": null,
    "sla_elapsed_time_unit": null,
    "use_last_activity": false,
    "sla_last_activity_time": null,
    "sla_last_activity_time_unit": null
  },
  "last_activity_at": "2024-11-08T14:15:05-03:00",
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 1,
  "responsible_id": "coyote-1177",
  "task_state_id": 2,
  "responsible_name": "Coyote 1177",
  "task_state_name": "Board Stage 1383",
  "activities_7_days_ago": 0,
  "repetition_rule_id": null,
  "current_worked_time": 0,
  "estimated_delivery_date_updated": true,
  "last_estimated_at": "2024-11-08T14:15:05-03:00",
  "task_tags": [

  ],
  "approved": null,
  "task_status_id": 2,
  "task_status_name": "Board Stage 1383",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-1177",
      "team_id": null,
      "assignee_name": "Coyote 1177",
      "team_name": null,
      "queue_position": 1,
      "priority": 1,
      "current_estimate_seconds": 3600,
      "time_worked": 0,
      "estimated_start_date": null,
      "estimate_updated": false,
      "start_date": "2024-11-08T14:15:04-03:00",
      "close_date": null,
      "is_closed": false,
      "reestimate_count": 0,
      "is_working_on": false,
      "automatic_time_worked_updated_at": "2024-11-08T14:15:04-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-928/coyote-1177/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-928/coyote-1177/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 "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

{
  "id": 4,
  "title": "Bla 291",
  "is_working_on": false,
  "user_id": "coyote-1180",
  "guest_id": null,
  "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": 2,
  "created_at": "2024-11-08T14:15:09-03:00",
  "start_date": null,
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 493",
  "client_id": 4,
  "project_name": "Test project 463",
  "project_group_name": "No group",
  "project_group_id": 4,
  "project_group_is_default": true,
  "project_sub_group_name": "No subgroup",
  "project_sub_group_id": 4,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 522",
  "user_name": "Coyote 1180",
  "guest_name": null,
  "board_name": "Board 464",
  "board_stage_name": "Board Stage 1409",
  "board_stage_description": null,
  "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,
  "parent_ids": [

  ],
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "child_ids": [

  ],
  "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,
  "all_subtasks_time_worked": null,
  "all_subtasks_times_updating": false,
  "all_subtasks_time_total": null,
  "all_subtasks_time_progress": null,
  "current_level": 0,
  "evaluator_ids": null,
  "pending_evaluator_ids": null,
  "approved_evaluator_ids": null,
  "rejected_evaluator_ids": null,
  "custom_fields": {
  },
  "form_id": null,
  "board_stage_data": {
    "fields": [

    ],
    "use_elapsed_time": false,
    "sla_elapsed_time": null,
    "sla_elapsed_time_unit": null,
    "use_last_activity": false,
    "sla_last_activity_time": null,
    "sla_last_activity_time_unit": null
  },
  "last_activity_at": "2024-11-08T14:15:09-03:00",
  "priority": 2,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 4,
  "responsible_id": "coyote-1180",
  "task_state_id": 10,
  "responsible_name": "Coyote 1180",
  "task_state_name": "Board Stage 1409",
  "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 1409",
  "assignments": [
    {
      "id": "1254deb6e4",
      "task_id": 4,
      "assignee_id": "coyote-1180",
      "team_id": null,
      "assignee_name": "Coyote 1180",
      "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": "2024-11-08T14:15:09-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-931/coyote-1180/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-931/coyote-1180/regular.png",
      "time_worked_not_persisted": 0
    }
  ],
  "follower_ids": [

  ]
}

POST

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

Reestimate a Task using assingee_id param

Parameters

Name	Description	type
id required	Task ID	integer
work_seconds required	The new effort (in seconds)	integer
assignee_id	If present only the informed assignee effort will be affected	string

Request

Route

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

Headers

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

Body

{
  "work_seconds": 666,
  "assignee_id": "coyote-1183"
}

cURL

curl "https://runrun.it/api/v1.0/tasks/1/reestimate" -d '{"work_seconds":666,"assignee_id":"coyote-1183"}' -X POST \
	-H "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

{
  "id": 1,
  "title": "Bla 293",
  "is_working_on": false,
  "user_id": "coyote-1184",
  "guest_id": null,
  "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": "2024-11-08T14:15:12-03:00",
  "start_date": null,
  "desired_start_date": null,
  "current_estimate_seconds": 4266,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 495",
  "client_id": 1,
  "project_name": "Test project 465",
  "project_group_name": "No group",
  "project_group_id": 1,
  "project_group_is_default": true,
  "project_sub_group_name": "No subgroup",
  "project_sub_group_id": 1,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 524",
  "user_name": "Coyote 1184",
  "guest_name": null,
  "board_name": "Board 466",
  "board_stage_name": "Board Stage 1415",
  "board_stage_description": null,
  "team_name": null,
  "type_color": "FFFFFF",
  "state": "queued",
  "overdue": "on_schedule",
  "time_worked": 0,
  "time_pending": 4266,
  "time_total": 4266,
  "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": 1,
  "parent_ids": [

  ],
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "child_ids": [

  ],
  "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,
  "all_subtasks_time_worked": null,
  "all_subtasks_times_updating": false,
  "all_subtasks_time_total": null,
  "all_subtasks_time_progress": null,
  "current_level": 0,
  "evaluator_ids": null,
  "pending_evaluator_ids": null,
  "approved_evaluator_ids": null,
  "rejected_evaluator_ids": null,
  "custom_fields": {
  },
  "form_id": null,
  "board_stage_data": {
    "fields": [

    ],
    "use_elapsed_time": false,
    "sla_elapsed_time": null,
    "sla_elapsed_time_unit": null,
    "use_last_activity": false,
    "sla_last_activity_time": null,
    "sla_last_activity_time_unit": null
  },
  "last_activity_at": "2024-11-08T14:15:12-03:00",
  "priority": null,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 1,
  "responsible_id": "coyote-1184",
  "task_state_id": 1,
  "responsible_name": "Coyote 1184",
  "task_state_name": "Board Stage 1415",
  "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 1415",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-1182",
      "team_id": null,
      "assignee_name": "Coyote 1182",
      "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": "2024-11-08T14:15:12-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-933/coyote-1182/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-933/coyote-1182/regular.png",
      "time_worked_not_persisted": 0
    },
    {
      "id": "92a6f5b72",
      "task_id": 1,
      "assignee_id": "coyote-1183",
      "team_id": null,
      "assignee_name": "Coyote 1183",
      "team_name": null,
      "queue_position": 1,
      "priority": 1,
      "current_estimate_seconds": 666,
      "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": "2024-11-08T14:15:12-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-933/coyote-1183/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-933/coyote-1183/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	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 "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

{
  "id": 1,
  "title": "Bla 296",
  "is_working_on": false,
  "user_id": "coyote-1191",
  "guest_id": null,
  "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": "2024-11-08T14:15:16-03:00",
  "start_date": null,
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 498",
  "client_id": 1,
  "project_name": "Test project 468",
  "project_group_name": "No group",
  "project_group_id": 1,
  "project_group_is_default": true,
  "project_sub_group_name": "No subgroup",
  "project_sub_group_id": 1,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 527",
  "user_name": "Coyote 1191",
  "guest_name": null,
  "board_name": "Board 469",
  "board_stage_name": "Board Stage 1424",
  "board_stage_description": null,
  "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,
  "parent_ids": [

  ],
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "child_ids": [

  ],
  "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,
  "all_subtasks_time_worked": null,
  "all_subtasks_times_updating": false,
  "all_subtasks_time_total": null,
  "all_subtasks_time_progress": null,
  "current_level": 0,
  "evaluator_ids": null,
  "pending_evaluator_ids": null,
  "approved_evaluator_ids": null,
  "rejected_evaluator_ids": null,
  "custom_fields": {
  },
  "form_id": null,
  "board_stage_data": {
    "fields": [

    ],
    "use_elapsed_time": false,
    "sla_elapsed_time": null,
    "sla_elapsed_time_unit": null,
    "use_last_activity": false,
    "sla_last_activity_time": null,
    "sla_last_activity_time_unit": null
  },
  "last_activity_at": "2024-11-08T14:15:17-03:00",
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 1,
  "responsible_id": "coyote-1190",
  "task_state_id": 1,
  "responsible_name": "Coyote 1190",
  "task_state_name": "Board Stage 1424",
  "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 1424",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-1190",
      "team_id": null,
      "assignee_name": "Coyote 1190",
      "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": "2024-11-08T14:15:16-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-936/coyote-1190/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-936/coyote-1190/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 "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

{
  "id": 1,
  "title": "Bla 297",
  "is_working_on": false,
  "user_id": "coyote-1193",
  "guest_id": null,
  "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": "2024-11-08T14:15:20-03:00",
  "start_date": null,
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 499",
  "client_id": 1,
  "project_name": "Test project 469",
  "project_group_name": "No group",
  "project_group_id": 1,
  "project_group_is_default": true,
  "project_sub_group_name": "No subgroup",
  "project_sub_group_id": 1,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 528",
  "user_name": "Coyote 1193",
  "guest_name": null,
  "board_name": "Board 470",
  "board_stage_name": "Board Stage 1427",
  "board_stage_description": null,
  "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,
  "parent_ids": [

  ],
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "child_ids": [

  ],
  "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,
  "all_subtasks_time_worked": null,
  "all_subtasks_times_updating": false,
  "all_subtasks_time_total": null,
  "all_subtasks_time_progress": null,
  "current_level": 0,
  "evaluator_ids": null,
  "pending_evaluator_ids": null,
  "approved_evaluator_ids": null,
  "rejected_evaluator_ids": null,
  "custom_fields": {
  },
  "form_id": null,
  "board_stage_data": {
    "fields": [

    ],
    "use_elapsed_time": false,
    "sla_elapsed_time": null,
    "sla_elapsed_time_unit": null,
    "use_last_activity": false,
    "sla_last_activity_time": null,
    "sla_last_activity_time_unit": null
  },
  "last_activity_at": "2024-11-08T14:15:20-03:00",
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 1,
  "responsible_id": "coyote-1192",
  "task_state_id": 1,
  "responsible_name": "Coyote 1192",
  "task_state_name": "Board Stage 1427",
  "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 1427",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-1192",
      "team_id": null,
      "assignee_name": "Coyote 1192",
      "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": "2024-11-08T14:15:20-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-937/coyote-1192/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-937/coyote-1192/regular.png",
      "time_worked_not_persisted": 0
    }
  ],
  "follower_ids": [

  ]
}

POST

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

Complete a workflow step

Parameters

Name	Description	type
id required	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 "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

{
  "id": 1,
  "title": "Bla 302",
  "is_working_on": false,
  "user_id": "coyote-1201",
  "guest_id": null,
  "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": "2024-11-08T14:15:26-03:00",
  "start_date": null,
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 504",
  "client_id": 1,
  "project_name": "Test project 474",
  "project_group_name": "No group",
  "project_group_id": 1,
  "project_group_is_default": true,
  "project_sub_group_name": "No subgroup",
  "project_sub_group_id": 1,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 533",
  "user_name": "Coyote 1201",
  "guest_name": null,
  "board_name": "Board 475",
  "board_stage_name": "Board Stage 1442",
  "board_stage_description": null,
  "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,
  "parent_ids": [

  ],
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "child_ids": [

  ],
  "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,
  "all_subtasks_time_worked": null,
  "all_subtasks_times_updating": false,
  "all_subtasks_time_total": null,
  "all_subtasks_time_progress": null,
  "current_level": 0,
  "evaluator_ids": null,
  "pending_evaluator_ids": null,
  "approved_evaluator_ids": null,
  "rejected_evaluator_ids": null,
  "custom_fields": {
  },
  "form_id": null,
  "board_stage_data": {
    "fields": [

    ],
    "use_elapsed_time": false,
    "sla_elapsed_time": null,
    "sla_elapsed_time_unit": null,
    "use_last_activity": false,
    "sla_last_activity_time": null,
    "sla_last_activity_time_unit": null
  },
  "last_activity_at": "2024-11-08T14:15:26-03:00",
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 1,
  "responsible_id": "coyote-1203",
  "task_state_id": 1,
  "responsible_name": "Coyote 1203",
  "task_state_name": "Board Stage 1442",
  "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 1442",
  "assignments": [
    {
      "id": "92a6f5b72",
      "task_id": 1,
      "assignee_id": "coyote-1203",
      "team_id": null,
      "assignee_name": "Coyote 1203",
      "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": "2024-11-08T14:15:26-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-940/coyote-1203/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-940/coyote-1203/regular.png",
      "time_worked_not_persisted": 0
    }
  ],
  "follower_ids": [
    "coyote-1201"
  ]
}

POST

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

Undo a workflow step

Parameters

Name	Description	type
id required	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 "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

{
  "id": 1,
  "title": "Bla 304",
  "is_working_on": false,
  "user_id": "coyote-1210",
  "guest_id": null,
  "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": "2024-11-08T14:15:31-03:00",
  "start_date": null,
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 506",
  "client_id": 1,
  "project_name": "Test project 476",
  "project_group_name": "No group",
  "project_group_id": 1,
  "project_group_is_default": true,
  "project_sub_group_name": "No subgroup",
  "project_sub_group_id": 1,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 535",
  "user_name": "Coyote 1210",
  "guest_name": null,
  "board_name": "Board 477",
  "board_stage_name": "Board Stage 1448",
  "board_stage_description": null,
  "team_name": "Test team 68",
  "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,
  "parent_ids": [

  ],
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "child_ids": [

  ],
  "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,
  "all_subtasks_time_worked": null,
  "all_subtasks_times_updating": false,
  "all_subtasks_time_total": null,
  "all_subtasks_time_progress": null,
  "current_level": 0,
  "evaluator_ids": null,
  "pending_evaluator_ids": null,
  "approved_evaluator_ids": null,
  "rejected_evaluator_ids": null,
  "custom_fields": {
  },
  "form_id": null,
  "board_stage_data": {
    "fields": [

    ],
    "use_elapsed_time": false,
    "sla_elapsed_time": null,
    "sla_elapsed_time_unit": null,
    "use_last_activity": false,
    "sla_last_activity_time": null,
    "sla_last_activity_time_unit": null
  },
  "last_activity_at": "2024-11-08T14:15:31-03:00",
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 1,
  "responsible_id": "coyote-1209",
  "task_state_id": 1,
  "responsible_name": "Coyote 1209",
  "task_state_name": "Board Stage 1448",
  "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 1448",
  "assignments": [
    {
      "id": "dbfa7092b",
      "task_id": 1,
      "assignee_id": "coyote-1209",
      "team_id": 1,
      "assignee_name": "Coyote 1209",
      "team_name": "Test team 68",
      "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": "2024-11-08T14:15:31-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-944/coyote-1209/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-944/coyote-1209/regular.png",
      "time_worked_not_persisted": 0
    }
  ],
  "follower_ids": [
    "coyote-1207",
    "coyote-1209"
  ]
}

POST

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

Mark a task as urgent

Parameters

Name	Description	type
id required	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 "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

{
  "id": 1,
  "title": "Bla 310",
  "is_working_on": false,
  "user_id": "coyote-1225",
  "guest_id": null,
  "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": "2024-11-08T14:15:42-03:00",
  "start_date": null,
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 512",
  "client_id": 1,
  "project_name": "Test project 482",
  "project_group_name": "No group",
  "project_group_id": 1,
  "project_group_is_default": true,
  "project_sub_group_name": "No subgroup",
  "project_sub_group_id": 1,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 541",
  "user_name": "Coyote 1225",
  "guest_name": null,
  "board_name": "Board 483",
  "board_stage_name": "Board Stage 1466",
  "board_stage_description": null,
  "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,
  "parent_ids": [

  ],
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "child_ids": [

  ],
  "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,
  "all_subtasks_time_worked": null,
  "all_subtasks_times_updating": false,
  "all_subtasks_time_total": null,
  "all_subtasks_time_progress": null,
  "current_level": 0,
  "evaluator_ids": null,
  "pending_evaluator_ids": null,
  "approved_evaluator_ids": null,
  "rejected_evaluator_ids": null,
  "custom_fields": {
  },
  "form_id": null,
  "board_stage_data": {
    "fields": [

    ],
    "use_elapsed_time": false,
    "sla_elapsed_time": null,
    "sla_elapsed_time_unit": null,
    "use_last_activity": false,
    "sla_last_activity_time": null,
    "sla_last_activity_time_unit": null
  },
  "last_activity_at": "2024-11-08T14:15:42-03:00",
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 1,
  "responsible_id": "coyote-1224",
  "task_state_id": 1,
  "responsible_name": "Coyote 1224",
  "task_state_name": "Board Stage 1466",
  "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 1466",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-1224",
      "team_id": null,
      "assignee_name": "Coyote 1224",
      "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": "2024-11-08T14:15:42-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-951/coyote-1224/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-951/coyote-1224/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 required	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 "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

{
  "id": 1,
  "title": "Bla 311",
  "is_working_on": false,
  "user_id": "coyote-1227",
  "guest_id": null,
  "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": "2024-11-08T14:15:44-03:00",
  "start_date": null,
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 513",
  "client_id": 1,
  "project_name": "Test project 483",
  "project_group_name": "No group",
  "project_group_id": 1,
  "project_group_is_default": true,
  "project_sub_group_name": "No subgroup",
  "project_sub_group_id": 1,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 542",
  "user_name": "Coyote 1227",
  "guest_name": null,
  "board_name": "Board 484",
  "board_stage_name": "Board Stage 1469",
  "board_stage_description": null,
  "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,
  "parent_ids": [

  ],
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "child_ids": [

  ],
  "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,
  "all_subtasks_time_worked": null,
  "all_subtasks_times_updating": false,
  "all_subtasks_time_total": null,
  "all_subtasks_time_progress": null,
  "current_level": 0,
  "evaluator_ids": null,
  "pending_evaluator_ids": null,
  "approved_evaluator_ids": null,
  "rejected_evaluator_ids": null,
  "custom_fields": {
  },
  "form_id": null,
  "board_stage_data": {
    "fields": [

    ],
    "use_elapsed_time": false,
    "sla_elapsed_time": null,
    "sla_elapsed_time_unit": null,
    "use_last_activity": false,
    "sla_last_activity_time": null,
    "sla_last_activity_time_unit": null
  },
  "last_activity_at": "2024-11-08T14:15:44-03:00",
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 1,
  "responsible_id": "coyote-1226",
  "task_state_id": 1,
  "responsible_name": "Coyote 1226",
  "task_state_name": "Board Stage 1469",
  "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 1469",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-1226",
      "team_id": null,
      "assignee_name": "Coyote 1226",
      "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": "2024-11-08T14:15:44-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-952/coyote-1226/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-952/coyote-1226/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	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-1229",
      "team_id": 1
    }
  ]
}

cURL

curl "https://runrun.it/api/v1.0/tasks/1/create_assignments" -d '{"assignments":[{"assignee_id":"coyote-1229","team_id":1}]}' -X POST \
	-H "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

{
  "id": 1,
  "title": "Bla 312",
  "is_working_on": false,
  "user_id": "coyote-1231",
  "guest_id": null,
  "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": "2024-11-08T14:15:46-03:00",
  "start_date": null,
  "desired_start_date": null,
  "current_estimate_seconds": 7200,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 514",
  "client_id": 1,
  "project_name": "Test project 484",
  "project_group_name": "No group",
  "project_group_id": 1,
  "project_group_is_default": true,
  "project_sub_group_name": "No subgroup",
  "project_sub_group_id": 1,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 543",
  "user_name": "Coyote 1231",
  "guest_name": null,
  "board_name": "Board 485",
  "board_stage_name": "Board Stage 1472",
  "board_stage_description": null,
  "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,
  "parent_ids": [

  ],
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "child_ids": [

  ],
  "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,
  "all_subtasks_time_worked": null,
  "all_subtasks_times_updating": false,
  "all_subtasks_time_total": null,
  "all_subtasks_time_progress": null,
  "current_level": 0,
  "evaluator_ids": null,
  "pending_evaluator_ids": null,
  "approved_evaluator_ids": null,
  "rejected_evaluator_ids": null,
  "custom_fields": {
  },
  "form_id": null,
  "board_stage_data": {
    "fields": [

    ],
    "use_elapsed_time": false,
    "sla_elapsed_time": null,
    "sla_elapsed_time_unit": null,
    "use_last_activity": false,
    "sla_last_activity_time": null,
    "sla_last_activity_time_unit": null
  },
  "last_activity_at": "2024-11-08T14:15:46-03:00",
  "priority": null,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 1,
  "responsible_id": "coyote-1228",
  "task_state_id": 1,
  "responsible_name": "Coyote 1228",
  "task_state_name": "Board Stage 1472",
  "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 1472",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-1228",
      "team_id": null,
      "assignee_name": "Coyote 1228",
      "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": "2024-11-08T14:15:46-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-953/coyote-1228/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-953/coyote-1228/regular.png",
      "time_worked_not_persisted": 0
    },
    {
      "id": "92a6f5b72",
      "task_id": 1,
      "assignee_id": "coyote-1229",
      "team_id": 1,
      "assignee_name": "Coyote 1229",
      "team_name": "Test team 69",
      "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": "2024-11-08T14:15:46-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-953/coyote-1229/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-953/coyote-1229/regular.png",
      "time_worked_not_persisted": 0
    }
  ],
  "follower_ids": [

  ]
}

POST

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

Move a task to top

Parameters

Name	Description	type
id required	Task ID	integer

Request

Route

POST /api/v1.0/tasks/2/move_to_top

Headers

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

cURL

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

Response

Simulated Response

Status

Headers

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

Body

{
  "id": 2,
  "title": "Bla 316",
  "is_working_on": false,
  "user_id": "coyote-1242",
  "guest_id": null,
  "type_id": 2,
  "project_id": 2,
  "team_id": null,
  "board_id": 3,
  "board_stage_id": 4,
  "board_stage_position": 35184372088832,
  "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": "2024-11-08T14:15:53-03:00",
  "start_date": null,
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 518",
  "client_id": 2,
  "project_name": "Test project 488",
  "project_group_name": "No group",
  "project_group_id": 2,
  "project_group_is_default": true,
  "project_sub_group_name": "No subgroup",
  "project_sub_group_id": 2,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 547",
  "user_name": "Coyote 1242",
  "guest_name": null,
  "board_name": "Board 490",
  "board_stage_name": "Board Stage 1484",
  "board_stage_description": null,
  "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,
  "parent_ids": [

  ],
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "child_ids": [

  ],
  "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,
  "all_subtasks_time_worked": null,
  "all_subtasks_times_updating": false,
  "all_subtasks_time_total": null,
  "all_subtasks_time_progress": null,
  "current_level": 0,
  "evaluator_ids": null,
  "pending_evaluator_ids": null,
  "approved_evaluator_ids": null,
  "rejected_evaluator_ids": null,
  "custom_fields": {
  },
  "form_id": null,
  "board_stage_data": {
    "fields": [

    ],
    "use_elapsed_time": false,
    "sla_elapsed_time": null,
    "sla_elapsed_time_unit": null,
    "use_last_activity": false,
    "sla_last_activity_time": null,
    "sla_last_activity_time_unit": null
  },
  "last_activity_at": "2024-11-08T14:15:53-03:00",
  "priority": 2,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 2,
  "responsible_id": "coyote-1240",
  "task_state_id": 4,
  "responsible_name": "Coyote 1240",
  "task_state_name": "Board Stage 1484",
  "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 1484",
  "assignments": [
    {
      "id": "92a6f5b72",
      "task_id": 2,
      "assignee_id": "coyote-1240",
      "team_id": null,
      "assignee_name": "Coyote 1240",
      "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": "2024-11-08T14:15:53-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-959/coyote-1240/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-959/coyote-1240/regular.png",
      "time_worked_not_persisted": 0
    }
  ],
  "follower_ids": [

  ]
}

POST

/api/v1.0/tasks/clone

Clone a task

POST

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

Move a task to next stage

Parameters

Name	Description	type
id required	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 "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

{
  "id": 1,
  "title": "Bla 318",
  "is_working_on": false,
  "user_id": "coyote-1246",
  "guest_id": null,
  "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": "2024-11-08T14:15:57-03:00",
  "queue_position": 1,
  "created_at": "2024-11-08T14:15:57-03:00",
  "start_date": null,
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 520",
  "client_id": 1,
  "project_name": "Test project 490",
  "project_group_name": "No group",
  "project_group_id": 1,
  "project_group_is_default": true,
  "project_sub_group_name": "No subgroup",
  "project_sub_group_id": 1,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 549",
  "user_name": "Coyote 1246",
  "guest_name": null,
  "board_name": "Board 492",
  "board_stage_name": "Board Stage 1495",
  "board_stage_description": null,
  "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,
  "parent_ids": [

  ],
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "child_ids": [

  ],
  "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,
  "all_subtasks_time_worked": null,
  "all_subtasks_times_updating": false,
  "all_subtasks_time_total": null,
  "all_subtasks_time_progress": null,
  "current_level": 0,
  "evaluator_ids": null,
  "pending_evaluator_ids": null,
  "approved_evaluator_ids": null,
  "rejected_evaluator_ids": null,
  "custom_fields": {
  },
  "form_id": null,
  "board_stage_data": {
    "fields": [

    ],
    "use_elapsed_time": false,
    "sla_elapsed_time": null,
    "sla_elapsed_time_unit": null,
    "use_last_activity": false,
    "sla_last_activity_time": null,
    "sla_last_activity_time_unit": null
  },
  "last_activity_at": "2024-11-08T14:15:57-03:00",
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 1,
  "responsible_id": "coyote-1245",
  "task_state_id": 2,
  "responsible_name": "Coyote 1245",
  "task_state_name": "Board Stage 1495",
  "activities_7_days_ago": 0,
  "repetition_rule_id": null,
  "current_worked_time": 0,
  "estimated_delivery_date_updated": true,
  "last_estimated_at": "2024-11-08T14:15:57-03:00",
  "task_tags": [

  ],
  "approved": null,
  "task_status_id": 2,
  "task_status_name": "Board Stage 1495",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-1245",
      "team_id": null,
      "assignee_name": "Coyote 1245",
      "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": "2024-11-08T14:15:57-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-961/coyote-1245/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-961/coyote-1245/regular.png",
      "time_worked_not_persisted": 0
    }
  ],
  "follower_ids": [

  ]
}

GET

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

Get answers to the form which created the task

GET

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

List fields from task's board

Request

Route

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

Headers

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

cURL

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

Response

Simulated Response

Status

Headers

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

Body

[
  {
    "id": "board",
    "label": "Board",
    "field_type": "board",
    "details": {
    },
    "position": 70368744177664,
    "description": null,
    "status": "active",
    "category": "default",
    "board_id": 1,
    "created_at": "2024-11-08T14:16:22-03:00"
  },
  {
    "id": "board_stage",
    "label": "Stage",
    "field_type": "board_stage",
    "details": {
    },
    "position": 140737488355328,
    "description": null,
    "status": "active",
    "category": "default",
    "board_id": 1,
    "created_at": "2024-11-08T14:16:22-03:00"
  },
  {
    "id": "board_stage_elapsed_time",
    "label": "Elapsed stage time",
    "field_type": "board_stage_elapsed_time",
    "details": {
    },
    "position": 211106232532992,
    "description": null,
    "status": "active",
    "category": "default",
    "board_id": 1,
    "created_at": "2024-11-08T14:16:22-03:00"
  },
  {
    "id": "last_activity",
    "label": "Last update",
    "field_type": "last_activity",
    "details": {
    },
    "position": 281474976710656,
    "description": null,
    "status": "active",
    "category": "default",
    "board_id": 1,
    "created_at": "2024-11-08T14:16:22-03:00"
  },
  {
    "id": "tags",
    "label": "Tags",
    "field_type": "tags",
    "details": {
    },
    "position": 351843720888320,
    "description": null,
    "status": "active",
    "category": "default",
    "board_id": 1,
    "created_at": "2024-11-08T14:16:22-03:00"
  },
  {
    "id": "task_type",
    "label": "Type",
    "field_type": "task_type",
    "details": {
    },
    "position": 422212465065984,
    "description": null,
    "status": "active",
    "category": "default",
    "board_id": 1,
    "created_at": "2024-11-08T14:16:22-03:00"
  },
  {
    "id": "project",
    "label": "Project",
    "field_type": "project",
    "details": {
    },
    "position": 492581209243648,
    "description": null,
    "status": "active",
    "category": "default",
    "board_id": 1,
    "created_at": "2024-11-08T14:16:22-03:00"
  },
  {
    "id": "custom_2",
    "label": null,
    "field_type": "divider",
    "details": {
    },
    "position": 562949953421312,
    "description": null,
    "status": "active",
    "category": "custom",
    "board_id": 1,
    "created_at": "2024-11-08T14:16:22-03:00"
  },
  {
    "id": "desired_start_date",
    "label": "Desired start",
    "field_type": "date",
    "details": {
      "include_time": true
    },
    "position": 633318697598976,
    "description": null,
    "status": "active",
    "category": "default",
    "board_id": 1,
    "created_at": "2024-11-08T14:16:22-03:00"
  },
  {
    "id": "desired_delivery_date",
    "label": "Desired due date",
    "field_type": "date",
    "details": {
      "include_time": true
    },
    "position": 703687441776640,
    "description": null,
    "status": "active",
    "category": "default",
    "board_id": 1,
    "created_at": "2024-11-08T14:16:22-03:00"
  },
  {
    "id": "repetition_rule",
    "label": "Repetition",
    "field_type": "repetition_rule",
    "details": {
    },
    "position": 774056185954304,
    "description": null,
    "status": "active",
    "category": "default",
    "board_id": 1,
    "created_at": "2024-11-08T14:16:22-03:00"
  },
  {
    "id": "start_date",
    "label": "Start date",
    "field_type": "date",
    "details": {
      "include_time": true
    },
    "position": 844424930131968,
    "description": null,
    "status": "active",
    "category": "default",
    "board_id": 1,
    "created_at": "2024-11-08T14:16:22-03:00"
  },
  {
    "id": "close_date",
    "label": "Delivery date",
    "field_type": "date",
    "details": {
      "include_time": true
    },
    "position": 914793674309632,
    "description": null,
    "status": "active",
    "category": "default",
    "board_id": 1,
    "created_at": "2024-11-08T14:16:22-03:00"
  },
  {
    "id": "custom_3",
    "label": null,
    "field_type": "divider",
    "details": {
    },
    "position": 985162418487296,
    "description": null,
    "status": "active",
    "category": "custom",
    "board_id": 1,
    "created_at": "2024-11-08T14:16:22-03:00"
  },
  {
    "id": "time",
    "label": "Time",
    "field_type": "time",
    "details": {
    },
    "position": 1055531162664960,
    "description": null,
    "status": "active",
    "category": "default",
    "board_id": 1,
    "created_at": "2024-11-08T14:16:22-03:00"
  },
  {
    "id": "custom_4",
    "label": null,
    "field_type": "divider",
    "details": {
    },
    "position": 1125899906842624,
    "description": null,
    "status": "active",
    "category": "custom",
    "board_id": 1,
    "created_at": "2024-11-08T14:16:22-03:00"
  },
  {
    "id": "followers",
    "label": "Followers",
    "field_type": "followers",
    "details": {
    },
    "position": 1196268651020288,
    "description": null,
    "status": "active",
    "category": "default",
    "board_id": 1,
    "created_at": "2024-11-08T14:16:22-03:00"
  },
  {
    "id": "checklist",
    "label": "Checklist",
    "field_type": "checklist",
    "details": {
    },
    "position": 1266637395197952,
    "description": null,
    "status": "active",
    "category": "default",
    "board_id": 1,
    "created_at": "2024-11-08T14:16:22-03:00"
  },
  {
    "id": "points",
    "label": "Points",
    "field_type": "numeric",
    "details": {
      "prefix": null,
      "suffix": null,
      "precision": 0
    },
    "position": 1337006139375616,
    "description": null,
    "status": "active",
    "category": "default",
    "board_id": 1,
    "created_at": "2024-11-08T14:16:22-03:00"
  },
  {
    "id": "custom_1",
    "label": "Nickname",
    "field_type": "short_text",
    "details": {
    },
    "position": 1407374883553280,
    "description": null,
    "status": "active",
    "category": "custom",
    "board_id": 1,
    "created_at": "2024-11-08T14:16:22-03:00"
  }
]

Tasks

GET

/api/v1.0/tasks

Query tasks

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

cURL

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

Response

Simulated Response

Status

Headers

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

Body

[
  {
    "id": 2,
    "title": "Improve Task API",
    "is_working_on": false,
    "user_id": "coyote-1017",
    "guest_id": null,
    "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": "2024-11-07T14:12:47-03:00",
    "was_reopened": false,
    "is_closed": true,
    "is_assigned": true,
    "on_going": false,
    "estimate_updated": true,
    "estimated_at": null,
    "queue_position": 2,
    "created_at": "2024-11-08T14:12:47-03:00",
    "start_date": null,
    "desired_start_date": null,
    "current_estimate_seconds": 3600,
    "evaluation_status": null,
    "attachments_count": 0,
    "tags_data": [

    ],
    "client_name": "Test client 416",
    "client_id": 1,
    "project_name": "Test project 385",
    "project_group_name": "No group",
    "project_group_id": 1,
    "project_group_is_default": true,
    "project_sub_group_name": "No subgroup",
    "project_sub_group_id": 1,
    "project_sub_group_is_default": true,
    "type_name": "TaskType 435",
    "user_name": "Coyote 1017",
    "guest_name": null,
    "board_name": "Board 368",
    "board_stage_name": "Board Stage 1123",
    "board_stage_description": null,
    "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,
    "parent_ids": [

    ],
    "opened_parent_ids": [

    ],
    "parents_max_desired_date": null,
    "child_ids": [

    ],
    "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,
    "all_subtasks_time_worked": null,
    "all_subtasks_times_updating": false,
    "all_subtasks_time_total": null,
    "all_subtasks_time_progress": null,
    "current_level": 0,
    "evaluator_ids": null,
    "pending_evaluator_ids": null,
    "approved_evaluator_ids": null,
    "rejected_evaluator_ids": null,
    "custom_fields": {
    },
    "form_id": null,
    "last_activity_at": "2024-11-08T14:12:47-03:00",
    "priority": 2,
    "tag_list": "",
    "tags": [

    ],
    "scheduled_start_time": null,
    "is_scheduled": false,
    "current_evaluator_id": null,
    "uid": 2,
    "responsible_id": "coyote-1015",
    "task_state_id": 4,
    "responsible_name": "Coyote 1015",
    "task_state_name": "Board Stage 1123",
    "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 1123",
    "assignments": [
      {
        "id": "92a6f5b72",
        "task_id": 2,
        "assignee_id": "coyote-1015",
        "team_id": null,
        "assignee_name": "Coyote 1015",
        "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": "2024-11-08T14:12:47-03:00",
        "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-857/coyote-1015/mini.png",
        "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-857/coyote-1015/regular.png",
        "time_worked_not_persisted": 0
      }
    ],
    "follower_ids": [

    ]
  },
  {
    "id": 1,
    "title": "Create Task API",
    "is_working_on": false,
    "user_id": "coyote-1016",
    "guest_id": null,
    "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": "2024-11-06T14:12:46-03:00",
    "was_reopened": false,
    "is_closed": true,
    "is_assigned": true,
    "on_going": false,
    "estimate_updated": true,
    "estimated_at": null,
    "queue_position": 1,
    "created_at": "2024-11-08T14:12:47-03:00",
    "start_date": null,
    "desired_start_date": null,
    "current_estimate_seconds": 3600,
    "evaluation_status": null,
    "attachments_count": 0,
    "tags_data": [

    ],
    "client_name": "Test client 416",
    "client_id": 1,
    "project_name": "Test project 385",
    "project_group_name": "No group",
    "project_group_id": 1,
    "project_group_is_default": true,
    "project_sub_group_name": "No subgroup",
    "project_sub_group_id": 1,
    "project_sub_group_is_default": true,
    "type_name": "TaskType 434",
    "user_name": "Coyote 1016",
    "guest_name": null,
    "board_name": "Board 367",
    "board_stage_name": "Board Stage 1120",
    "board_stage_description": null,
    "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,
    "parent_ids": [

    ],
    "opened_parent_ids": [

    ],
    "parents_max_desired_date": null,
    "child_ids": [

    ],
    "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,
    "all_subtasks_time_worked": null,
    "all_subtasks_times_updating": false,
    "all_subtasks_time_total": null,
    "all_subtasks_time_progress": null,
    "current_level": 0,
    "evaluator_ids": null,
    "pending_evaluator_ids": null,
    "approved_evaluator_ids": null,
    "rejected_evaluator_ids": null,
    "custom_fields": {
    },
    "form_id": null,
    "last_activity_at": "2024-11-08T14:12:47-03:00",
    "priority": 1,
    "tag_list": "",
    "tags": [

    ],
    "scheduled_start_time": null,
    "is_scheduled": false,
    "current_evaluator_id": null,
    "uid": 1,
    "responsible_id": "coyote-1015",
    "task_state_id": 1,
    "responsible_name": "Coyote 1015",
    "task_state_name": "Board Stage 1120",
    "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 1120",
    "assignments": [
      {
        "id": "49537adb9",
        "task_id": 1,
        "assignee_id": "coyote-1015",
        "team_id": null,
        "assignee_name": "Coyote 1015",
        "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": "2024-11-08T14:12:47-03:00",
        "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-857/coyote-1015/mini.png",
        "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-857/coyote-1015/regular.png",
        "time_worked_not_persisted": 0
      }
    ],
    "follower_ids": [

    ]
  }
]

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 -g "https://runrun.it/api/v1.0/tasks/1" -X GET \
	-H "Version: HTTP/1.0" \
	-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
guest_id	ID of guest 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
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
guest_name	Name of guest user who created the task	string
board_name	Name of board	string
board_stage_name	Name of board stage	string
board_stage_description	Description 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
all_subtasks_time_worked	Sum of time (in seconds) worked in all the subtasks from this task	integer
all_subtasks_times_updating	True if is updating subtasks times summations	boolean
all_subtasks_time_total	Sum of total time (in seconds) spent in all the subtasks from this task	integer
all_subtasks_time_progress	Progress of time worked on all the subtasks from this task	float
current_level	Depth level of this task on your tree	integer
evaluator_ids	IDs from evaluators	array
pending_evaluator_ids	IDs from pending evaluators	array
approved_evaluator_ids	IDs from approved evaluators	array
rejected_evaluator_ids	IDs from rejected evaluators	array
custom_fields	Task custom fields	object
form_id	ID of the form whom task was created from	integer
board_stage_data	Data about the task board stage	object
board_stage_elapsed_time	Time spent in seconds in the board stage	integer
board_stage_elapsed_time_updated_at	Datetime of the last update of the attribute board_stage_elapsed_time	datetime
is_board_stage_sla_elapsed_time_overdue	True if board stage SLA elapsed time is overdue	boolean
is_board_stage_sla_last_activity_time_overdue	True if board stage SLA activity time is overdue	boolean
last_activity_at	Datetime of last activity on the task	date_time
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
current_evaluator_id	[Deprecated] Use evaluator_ids	string
fields_metadata	[Deprecated] Board fields metadata	object
board_data	Data about the task board	object
follower_ids	IDs of users following this task	array
workflow_id	ID of associated workflow (if any)	integer

Status

Headers

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

Body

{
  "id": 1,
  "title": "Bla 230",
  "is_working_on": false,
  "user_id": "coyote-1056",
  "guest_id": null,
  "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": "2024-11-08T14:13:11-03:00",
  "start_date": null,
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 429",
  "client_id": 1,
  "project_name": "Test project 398",
  "project_group_name": "No group",
  "project_group_id": 1,
  "project_group_is_default": true,
  "project_sub_group_name": "No subgroup",
  "project_sub_group_id": 1,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 453",
  "user_name": "Coyote 1056",
  "guest_name": null,
  "board_name": "Board 386",
  "board_stage_name": "Board Stage 1177",
  "board_stage_description": null,
  "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,
  "parent_ids": [

  ],
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "child_ids": [

  ],
  "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,
  "all_subtasks_time_worked": null,
  "all_subtasks_times_updating": false,
  "all_subtasks_time_total": null,
  "all_subtasks_time_progress": null,
  "current_level": 0,
  "evaluator_ids": null,
  "pending_evaluator_ids": null,
  "approved_evaluator_ids": null,
  "rejected_evaluator_ids": null,
  "custom_fields": {
  },
  "form_id": null,
  "board_stage_data": {
    "fields": [

    ],
    "use_elapsed_time": false,
    "sla_elapsed_time": null,
    "sla_elapsed_time_unit": null,
    "use_last_activity": false,
    "sla_last_activity_time": null,
    "sla_last_activity_time_unit": null
  },
  "last_activity_at": "2024-11-08T14:13:11-03:00",
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 1,
  "responsible_id": "coyote-1055",
  "task_state_id": 1,
  "responsible_name": "Coyote 1055",
  "task_state_name": "Board Stage 1177",
  "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 1177",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-1055",
      "team_id": null,
      "assignee_name": "Coyote 1055",
      "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": "2024-11-08T14:13:11-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-868/coyote-1055/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-868/coyote-1055/regular.png",
      "time_worked_not_persisted": 0
    }
  ],
  "follower_ids": [

  ],
  "unseen_since": "2024-11-08T14:13:11-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 -g "https://runrun.it/api/v1.0/tasks/1/subtasks" -X GET \
	-H "Version: HTTP/1.0" \
	-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
guest_id	ID of guest 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
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
guest_name	Name of guest user who created the task	string
board_name	Name of board	string
board_stage_name	Name of board stage	string
board_stage_description	Description 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
all_subtasks_time_worked	Sum of time (in seconds) worked in all the subtasks from this task	integer
all_subtasks_times_updating	True if is updating subtasks times summations	boolean
all_subtasks_time_total	Sum of total time (in seconds) spent in all the subtasks from this task	integer
all_subtasks_time_progress	Progress of time worked on all the subtasks from this task	float
current_level	Depth level of this task on your tree	integer
evaluator_ids	IDs from evaluators	array
pending_evaluator_ids	IDs from pending evaluators	array
approved_evaluator_ids	IDs from approved evaluators	array
rejected_evaluator_ids	IDs from rejected evaluators	array
custom_fields	Task custom fields	object
form_id	ID of the form whom task was created from	integer
board_stage_data	Data about the task board stage	object
board_stage_elapsed_time	Time spent in seconds in the board stage	integer
board_stage_elapsed_time_updated_at	Datetime of the last update of the attribute board_stage_elapsed_time	datetime
is_board_stage_sla_elapsed_time_overdue	True if board stage SLA elapsed time is overdue	boolean
is_board_stage_sla_last_activity_time_overdue	True if board stage SLA activity time is overdue	boolean
last_activity_at	Datetime of last activity on the task	date_time
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
current_evaluator_id	[Deprecated] Use evaluator_ids	string
fields_metadata	[Deprecated] Board fields metadata	object
board_data	Data about the task board	object
follower_ids	IDs of users following this task	array
workflow_id	ID of associated workflow (if any)	integer

Status

Headers

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

Body

[
  {
    "id": 2,
    "title": "Subtask",
    "is_working_on": false,
    "user_id": "coyote-1059",
    "guest_id": null,
    "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": "2024-11-08T14:13:13-03:00",
    "start_date": null,
    "desired_start_date": null,
    "current_estimate_seconds": 3600,
    "evaluation_status": null,
    "attachments_count": 0,
    "tags_data": [

    ],
    "client_name": "Test client 431",
    "client_id": 2,
    "project_name": "Test project 400",
    "project_group_name": "No group",
    "project_group_id": 2,
    "project_group_is_default": true,
    "project_sub_group_name": "No subgroup",
    "project_sub_group_id": 2,
    "project_sub_group_is_default": true,
    "type_name": "TaskType 455",
    "user_name": "Coyote 1059",
    "guest_name": null,
    "board_name": "Board 388",
    "board_stage_name": "Board Stage 1183",
    "board_stage_description": null,
    "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,
    "parent_ids": [

    ],
    "opened_parent_ids": [

    ],
    "parents_max_desired_date": null,
    "child_ids": [

    ],
    "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,
    "all_subtasks_time_worked": null,
    "all_subtasks_times_updating": false,
    "all_subtasks_time_total": null,
    "all_subtasks_time_progress": null,
    "current_level": 1,
    "evaluator_ids": null,
    "pending_evaluator_ids": null,
    "approved_evaluator_ids": null,
    "rejected_evaluator_ids": null,
    "custom_fields": {
    },
    "form_id": null,
    "last_activity_at": "2024-11-08T14:13:13-03:00",
    "priority": 2,
    "tag_list": "",
    "tags": [

    ],
    "scheduled_start_time": null,
    "is_scheduled": false,
    "current_evaluator_id": null,
    "uid": 2,
    "responsible_id": "coyote-1057",
    "task_state_id": 4,
    "responsible_name": "Coyote 1057",
    "task_state_name": "Board Stage 1183",
    "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 1183",
    "assignments": [
      {
        "id": "92a6f5b72",
        "task_id": 2,
        "assignee_id": "coyote-1057",
        "team_id": null,
        "assignee_name": "Coyote 1057",
        "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": "2024-11-08T14:13:13-03:00",
        "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-869/coyote-1057/mini.png",
        "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-869/coyote-1057/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]	True if the task is an ongoing task	boolean
task[type_id] required	ID of the task type	integer
task[project_id]	ID of the project the task belongs to	integer
task[desired_start_date]	Desired start date	date_time
task[desired_date]	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 237",
    "desired_date": null,
    "on_going": false,
    "assignments": [
      {
        "assignee_id": "coyote-1070",
        "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 237","desired_date":null,"on_going":false,"assignments":[{"assignee_id":"coyote-1070","team_id":1}],"source":"my_source_value"}}' -X POST \
	-H "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

{
  "id": 1,
  "title": "Bla 237",
  "is_working_on": false,
  "user_id": "coyote-1070",
  "guest_id": null,
  "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": "2024-11-08T14:13:23-03:00",
  "queue_position": 1,
  "created_at": "2024-11-08T14:13:22-03:00",
  "start_date": null,
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 437",
  "client_id": 1,
  "project_name": "Test project 406",
  "project_group_name": "No group",
  "project_group_id": 1,
  "project_group_is_default": true,
  "project_sub_group_name": "No subgroup",
  "project_sub_group_id": 1,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 461",
  "user_name": "Coyote 1070",
  "guest_name": null,
  "board_name": "Board 394",
  "board_stage_name": "Board Stage 1201",
  "board_stage_description": null,
  "team_name": "Test team 55",
  "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,
  "parent_ids": [

  ],
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "child_ids": [

  ],
  "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,
  "all_subtasks_time_worked": null,
  "all_subtasks_times_updating": false,
  "all_subtasks_time_total": null,
  "all_subtasks_time_progress": null,
  "current_level": 0,
  "evaluator_ids": null,
  "pending_evaluator_ids": null,
  "approved_evaluator_ids": null,
  "rejected_evaluator_ids": null,
  "custom_fields": {
  },
  "form_id": null,
  "board_stage_data": {
    "fields": [

    ],
    "use_elapsed_time": false,
    "sla_elapsed_time": null,
    "sla_elapsed_time_unit": null,
    "use_last_activity": false,
    "sla_last_activity_time": null,
    "sla_last_activity_time_unit": null
  },
  "last_activity_at": "2024-11-08T14:13:22-03:00",
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 1,
  "responsible_id": "coyote-1070",
  "task_state_id": 1,
  "responsible_name": "Coyote 1070",
  "task_state_name": "Board Stage 1201",
  "activities_7_days_ago": 0,
  "repetition_rule_id": null,
  "current_worked_time": 0,
  "estimated_delivery_date_updated": true,
  "last_estimated_at": "2024-11-08T14:13:23-03:00",
  "task_tags": [

  ],
  "approved": null,
  "task_status_id": 1,
  "task_status_name": "Board Stage 1201",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-1070",
      "team_id": 1,
      "assignee_name": "Coyote 1070",
      "team_name": "Test team 55",
      "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": "2024-11-08T14:13:23-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-871/coyote-1070/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-871/coyote-1070/regular.png",
      "time_worked_not_persisted": 0
    }
  ],
  "follower_ids": [

  ]
}

PUT

/api/v1.0/tasks/:id

Update task title

Parameters

Name	Description	type
task[title] required	Task title	string

Request

Route

PUT /api/v1.0/tasks/1

Headers

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

Body

{
  "task": {
    "title": "New title"
  }
}

cURL

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

Response

Simulated Response

Status

Headers

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

Body

{
  "id": 1,
  "title": "New title",
  "is_working_on": false,
  "user_id": "coyote-1105",
  "guest_id": null,
  "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": "2024-11-08T14:13:54-03:00",
  "start_date": null,
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 449",
  "client_id": 1,
  "project_name": "Test project 418",
  "project_group_name": "No group",
  "project_group_id": 1,
  "project_group_is_default": true,
  "project_sub_group_name": "No subgroup",
  "project_sub_group_id": 1,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 477",
  "user_name": "Coyote 1105",
  "guest_name": null,
  "board_name": "Board 419",
  "board_stage_name": "Board Stage 1276",
  "board_stage_description": null,
  "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,
  "parent_ids": [

  ],
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "child_ids": [

  ],
  "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,
  "all_subtasks_time_worked": null,
  "all_subtasks_times_updating": false,
  "all_subtasks_time_total": null,
  "all_subtasks_time_progress": null,
  "current_level": 0,
  "evaluator_ids": null,
  "pending_evaluator_ids": null,
  "approved_evaluator_ids": null,
  "rejected_evaluator_ids": null,
  "custom_fields": {
  },
  "form_id": null,
  "board_stage_data": {
    "fields": [

    ],
    "use_elapsed_time": false,
    "sla_elapsed_time": null,
    "sla_elapsed_time_unit": null,
    "use_last_activity": false,
    "sla_last_activity_time": null,
    "sla_last_activity_time_unit": null
  },
  "last_activity_at": "2024-11-08T14:13:54-03:00",
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 1,
  "responsible_id": "coyote-1105",
  "task_state_id": 1,
  "responsible_name": "Coyote 1105",
  "task_state_name": "Board Stage 1276",
  "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 1276",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-1105",
      "team_id": null,
      "assignee_name": "Coyote 1105",
      "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": "2024-11-08T14:13:54-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-893/coyote-1105/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-893/coyote-1105/regular.png",
      "time_worked_not_persisted": 0
    }
  ],
  "follower_ids": [

  ]
}

PUT

/api/v1.0/tasks/:id

Update task desired start date

Parameters

Name	Description	type
task[desired_start_date]	Desired start date	date_time

Request

Route

PUT /api/v1.0/tasks/1

Headers

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

Body

{
  "task": {
    "desired_start_date": "2024-04-17T14:50:30-03:00"
  }
}

cURL

curl "https://runrun.it/api/v1.0/tasks/1" -d '{"task":{"desired_start_date":"2024-04-17T14:50:30-03:00"}}' -X PUT \
	-H "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

{
  "id": 1,
  "title": "Bla 248",
  "is_working_on": false,
  "user_id": "coyote-1107",
  "guest_id": null,
  "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": "2024-04-17T14:50:30-03:00",
  "gantt_bar_end_date": "2024-04-17T23:59:59-03:00",
  "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": "2024-11-08T14:13:56-03:00",
  "start_date": null,
  "desired_start_date": "2024-04-17T14:50:30-03:00",
  "current_estimate_seconds": 3600,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 450",
  "client_id": 1,
  "project_name": "Test project 419",
  "project_group_name": "No group",
  "project_group_id": 1,
  "project_group_is_default": true,
  "project_sub_group_name": "No subgroup",
  "project_sub_group_id": 1,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 478",
  "user_name": "Coyote 1107",
  "guest_name": null,
  "board_name": "Board 420",
  "board_stage_name": "Board Stage 1279",
  "board_stage_description": null,
  "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,
  "parent_ids": [

  ],
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "child_ids": [

  ],
  "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,
  "all_subtasks_time_worked": null,
  "all_subtasks_times_updating": false,
  "all_subtasks_time_total": null,
  "all_subtasks_time_progress": null,
  "current_level": 0,
  "evaluator_ids": null,
  "pending_evaluator_ids": null,
  "approved_evaluator_ids": null,
  "rejected_evaluator_ids": null,
  "custom_fields": {
  },
  "form_id": null,
  "board_stage_data": {
    "fields": [

    ],
    "use_elapsed_time": false,
    "sla_elapsed_time": null,
    "sla_elapsed_time_unit": null,
    "use_last_activity": false,
    "sla_last_activity_time": null,
    "sla_last_activity_time_unit": null
  },
  "last_activity_at": "2024-11-08T14:13:56-03:00",
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": "2024-04-17T14:50:30-03:00",
  "is_scheduled": true,
  "current_evaluator_id": null,
  "uid": 1,
  "responsible_id": "coyote-1107",
  "task_state_id": 1,
  "responsible_name": "Coyote 1107",
  "task_state_name": "Board Stage 1279",
  "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 1279",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-1107",
      "team_id": null,
      "assignee_name": "Coyote 1107",
      "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": "2024-11-08T14:13:56-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-894/coyote-1107/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-894/coyote-1107/regular.png",
      "time_worked_not_persisted": 0
    }
  ],
  "follower_ids": [

  ]
}

PUT

/api/v1.0/tasks/:id

Update task desired date

Parameters

Name	Description	type
task[desired_date]	Desired delivery date	date

Request

Route

PUT /api/v1.0/tasks/1

Headers

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

Body

{
  "task": {
    "desired_date": "2024-04-20T20:23:40-03:00"
  }
}

cURL

curl "https://runrun.it/api/v1.0/tasks/1" -d '{"task":{"desired_date":"2024-04-20T20:23:40-03:00"}}' -X PUT \
	-H "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

{
  "id": 1,
  "title": "Bla 250",
  "is_working_on": false,
  "user_id": "coyote-1111",
  "guest_id": null,
  "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": "2024-04-20",
  "desired_date_with_time": "2024-04-20T20:23:40-03:00",
  "estimated_start_date": null,
  "estimated_delivery_date": null,
  "gantt_bar_start_date": "2024-04-20T00:00:00-03:00",
  "gantt_bar_end_date": "2024-04-20T20:23:40-03:00",
  "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": "2024-11-08T14:14:00-03:00",
  "start_date": null,
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 452",
  "client_id": 1,
  "project_name": "Test project 421",
  "project_group_name": "No group",
  "project_group_id": 1,
  "project_group_is_default": true,
  "project_sub_group_name": "No subgroup",
  "project_sub_group_id": 1,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 480",
  "user_name": "Coyote 1111",
  "guest_name": null,
  "board_name": "Board 422",
  "board_stage_name": "Board Stage 1285",
  "board_stage_description": null,
  "team_name": null,
  "type_color": "FFFFFF",
  "state": "queued",
  "overdue": "hard_overdue",
  "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,
  "parent_ids": [

  ],
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "child_ids": [

  ],
  "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,
  "all_subtasks_time_worked": null,
  "all_subtasks_times_updating": false,
  "all_subtasks_time_total": null,
  "all_subtasks_time_progress": null,
  "current_level": 0,
  "evaluator_ids": null,
  "pending_evaluator_ids": null,
  "approved_evaluator_ids": null,
  "rejected_evaluator_ids": null,
  "custom_fields": {
  },
  "form_id": null,
  "board_stage_data": {
    "fields": [

    ],
    "use_elapsed_time": false,
    "sla_elapsed_time": null,
    "sla_elapsed_time_unit": null,
    "use_last_activity": false,
    "sla_last_activity_time": null,
    "sla_last_activity_time_unit": null
  },
  "last_activity_at": "2024-11-08T14:14:00-03:00",
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 1,
  "responsible_id": "coyote-1111",
  "task_state_id": 1,
  "responsible_name": "Coyote 1111",
  "task_state_name": "Board Stage 1285",
  "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 1285",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-1111",
      "team_id": null,
      "assignee_name": "Coyote 1111",
      "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": "2024-11-08T14:14:00-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-896/coyote-1111/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-896/coyote-1111/regular.png",
      "time_worked_not_persisted": 0
    }
  ],
  "follower_ids": [

  ]
}

PUT

/api/v1.0/tasks/:id

Update task tags

Parameters

Name	Description	type
task[tags_data]	Tags for task	array

Request

Route

PUT /api/v1.0/tasks/1

Headers

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

Body

{
  "task": {
    "tags_data": [
      {
        "name": "tag a",
        "color": "ffffff"
      },
      {
        "name": "tag b",
        "color": "000000"
      }
    ]
  }
}

cURL

curl "https://runrun.it/api/v1.0/tasks/1" -d '{"task":{"tags_data":[{"name":"tag a","color":"ffffff"},{"name":"tag b","color":"000000"}]}}' -X PUT \
	-H "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

{
  "id": 1,
  "title": "Bla 252",
  "is_working_on": false,
  "user_id": "coyote-1115",
  "guest_id": null,
  "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": "2024-11-08T14:14:03-03:00",
  "start_date": null,
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [
    {
      "name": "tag a",
      "color": "ffffff"
    },
    {
      "name": "tag b",
      "color": "000000"
    }
  ],
  "client_name": "Test client 454",
  "client_id": 1,
  "project_name": "Test project 423",
  "project_group_name": "No group",
  "project_group_id": 1,
  "project_group_is_default": true,
  "project_sub_group_name": "No subgroup",
  "project_sub_group_id": 1,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 482",
  "user_name": "Coyote 1115",
  "guest_name": null,
  "board_name": "Board 424",
  "board_stage_name": "Board Stage 1291",
  "board_stage_description": null,
  "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,
  "parent_ids": [

  ],
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "child_ids": [

  ],
  "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,
  "all_subtasks_time_worked": null,
  "all_subtasks_times_updating": false,
  "all_subtasks_time_total": null,
  "all_subtasks_time_progress": null,
  "current_level": 0,
  "evaluator_ids": null,
  "pending_evaluator_ids": null,
  "approved_evaluator_ids": null,
  "rejected_evaluator_ids": null,
  "custom_fields": {
  },
  "form_id": null,
  "board_stage_data": {
    "fields": [

    ],
    "use_elapsed_time": false,
    "sla_elapsed_time": null,
    "sla_elapsed_time_unit": null,
    "use_last_activity": false,
    "sla_last_activity_time": null,
    "sla_last_activity_time_unit": null
  },
  "last_activity_at": "2024-11-08T14:14:04-03:00",
  "priority": 1,
  "tag_list": "tag a, tag b",
  "tags": [
    "tag a",
    "tag b"
  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 1,
  "responsible_id": "coyote-1115",
  "task_state_id": 1,
  "responsible_name": "Coyote 1115",
  "task_state_name": "Board Stage 1291",
  "activities_7_days_ago": 0,
  "repetition_rule_id": null,
  "current_worked_time": 0,
  "estimated_delivery_date_updated": false,
  "last_estimated_at": null,
  "task_tags": [
    "tag a",
    "tag b"
  ],
  "approved": null,
  "task_status_id": 1,
  "task_status_name": "Board Stage 1291",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-1115",
      "team_id": null,
      "assignee_name": "Coyote 1115",
      "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": "2024-11-08T14:14:03-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-898/coyote-1115/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-898/coyote-1115/regular.png",
      "time_worked_not_persisted": 0
    }
  ],
  "follower_ids": [

  ]
}

PUT

/api/v1.0/tasks/:id

Update task points

Parameters

Name	Description	type
task[points]		integer

Request

Route

PUT /api/v1.0/tasks/1

Headers

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

Body

{
  "task": {
    "points": 8
  }
}

cURL

curl "https://runrun.it/api/v1.0/tasks/1" -d '{"task":{"points":8}}' -X PUT \
	-H "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

{
  "id": 1,
  "title": "Bla 257",
  "is_working_on": false,
  "user_id": "coyote-1125",
  "guest_id": null,
  "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": "2024-11-08T14:14:13-03:00",
  "start_date": null,
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 459",
  "client_id": 1,
  "project_name": "Test project 428",
  "project_group_name": "No group",
  "project_group_id": 1,
  "project_group_is_default": true,
  "project_sub_group_name": "No subgroup",
  "project_sub_group_id": 1,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 487",
  "user_name": "Coyote 1125",
  "guest_name": null,
  "board_name": "Board 429",
  "board_stage_name": "Board Stage 1306",
  "board_stage_description": null,
  "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": 8,
  "reestimate_count": 0,
  "parent_ids": [

  ],
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "child_ids": [

  ],
  "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,
  "all_subtasks_time_worked": null,
  "all_subtasks_times_updating": false,
  "all_subtasks_time_total": null,
  "all_subtasks_time_progress": null,
  "current_level": 0,
  "evaluator_ids": null,
  "pending_evaluator_ids": null,
  "approved_evaluator_ids": null,
  "rejected_evaluator_ids": null,
  "custom_fields": {
  },
  "form_id": null,
  "board_stage_data": {
    "fields": [

    ],
    "use_elapsed_time": false,
    "sla_elapsed_time": null,
    "sla_elapsed_time_unit": null,
    "use_last_activity": false,
    "sla_last_activity_time": null,
    "sla_last_activity_time_unit": null
  },
  "last_activity_at": "2024-11-08T14:14:13-03:00",
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 1,
  "responsible_id": "coyote-1125",
  "task_state_id": 1,
  "responsible_name": "Coyote 1125",
  "task_state_name": "Board Stage 1306",
  "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 1306",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-1125",
      "team_id": null,
      "assignee_name": "Coyote 1125",
      "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": "2024-11-08T14:14:13-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-903/coyote-1125/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-903/coyote-1125/regular.png",
      "time_worked_not_persisted": 0
    }
  ],
  "follower_ids": [

  ]
}

PUT

/api/v1.0/tasks/:id

Update task custom fields

Custom fields are identified by a "custom_" prefix followed by a number

To determine which custom fields can be filled in a task, you need to access the endpoint GET api/v1.0/tasks/:task_id/fields

The options of the fields of type 'single_option' and 'multiple_options' can be accessed in the endpoint GET api/v1.0/fields/:field_id/options

Parameters

Name	Description	type
task[custom_fields]	Task custom fields	object

Request

Route

PUT /api/v1.0/tasks/1

Headers

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

Body

{
  "task": {
    "custom_fields": {
      "custom_3": "new_text",
      "custom_4": 45,
      "custom_5": 30.23,
      "custom_6": 8,
      "custom_7": "2024-11-15",
      "custom_8": "2024-11-15T21:12:43-03:00",
      "custom_1": {
        "id": "2",
        "label": "Option 2"
      },
      "custom_2": [
        {
          "id": "3",
          "label": "Option A"
        },
        {
          "id": "4",
          "label": "Option B"
        }
      ]
    }
  }
}

cURL

curl "https://runrun.it/api/v1.0/tasks/1" -d '{"task":{"custom_fields":{"custom_3":"new_text","custom_4":45,"custom_5":30.23,"custom_6":8,"custom_7":"2024-11-15","custom_8":"2024-11-15T21:12:43-03:00","custom_1":{"id":"2","label":"Option 2"},"custom_2":[{"id":"3","label":"Option A"},{"id":"4","label":"Option B"}]}}}' -X PUT \
	-H "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

{
  "id": 1,
  "title": "Bla 260",
  "is_working_on": false,
  "user_id": "coyote-1131",
  "guest_id": null,
  "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": "2024-11-08T14:14:18-03:00",
  "start_date": null,
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 462",
  "client_id": 1,
  "project_name": "Test project 431",
  "project_group_name": "No group",
  "project_group_id": 1,
  "project_group_is_default": true,
  "project_sub_group_name": "No subgroup",
  "project_sub_group_id": 1,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 490",
  "user_name": "Coyote 1131",
  "guest_name": null,
  "board_name": "Board 432",
  "board_stage_name": "Board Stage 1315",
  "board_stage_description": null,
  "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,
  "parent_ids": [

  ],
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "child_ids": [

  ],
  "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,
  "all_subtasks_time_worked": null,
  "all_subtasks_times_updating": false,
  "all_subtasks_time_total": null,
  "all_subtasks_time_progress": null,
  "current_level": 0,
  "evaluator_ids": null,
  "pending_evaluator_ids": null,
  "approved_evaluator_ids": null,
  "rejected_evaluator_ids": null,
  "custom_fields": {
    "custom_1": {
      "id": "2",
      "label": "Option 2"
    },
    "custom_2": [
      {
        "id": "3",
        "label": "Option A"
      },
      {
        "id": "4",
        "label": "Option B"
      }
    ],
    "custom_3": "new_text",
    "custom_4": 45,
    "custom_5": 30.23,
    "custom_6": 8,
    "custom_7": "2024-11-15",
    "custom_8": "2024-11-15T21:12:43-03:00"
  },
  "form_id": null,
  "board_stage_data": {
    "fields": [

    ],
    "use_elapsed_time": false,
    "sla_elapsed_time": null,
    "sla_elapsed_time_unit": null,
    "use_last_activity": false,
    "sla_last_activity_time": null,
    "sla_last_activity_time_unit": null
  },
  "last_activity_at": "2024-11-08T14:14:19-03:00",
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 1,
  "responsible_id": "coyote-1131",
  "task_state_id": 1,
  "responsible_name": "Coyote 1131",
  "task_state_name": "Board Stage 1315",
  "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 1315",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-1131",
      "team_id": null,
      "assignee_name": "Coyote 1131",
      "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": "2024-11-08T14:14:18-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-906/coyote-1131/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-906/coyote-1131/regular.png",
      "time_worked_not_persisted": 0
    }
  ],
  "follower_ids": [

  ]
}

DELETE

/api/v1.0/tasks/:id

Destroy a Task

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 required	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 "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

{
  "id": 1,
  "title": "Bla 269",
  "is_working_on": true,
  "user_id": "coyote-1151",
  "guest_id": null,
  "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": "2024-11-08T14:14:39-03:00",
  "start_date": "2024-11-08T14:14:39-03:00",
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 471",
  "client_id": 1,
  "project_name": "Test project 440",
  "project_group_name": "No group",
  "project_group_id": 1,
  "project_group_is_default": true,
  "project_sub_group_name": "No subgroup",
  "project_sub_group_id": 1,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 499",
  "user_name": "Coyote 1151",
  "guest_name": null,
  "board_name": "Board 441",
  "board_stage_name": "Board Stage 1342",
  "board_stage_description": null,
  "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,
  "parent_ids": [

  ],
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "child_ids": [

  ],
  "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,
  "all_subtasks_time_worked": null,
  "all_subtasks_times_updating": false,
  "all_subtasks_time_total": null,
  "all_subtasks_time_progress": null,
  "current_level": 0,
  "evaluator_ids": null,
  "pending_evaluator_ids": null,
  "approved_evaluator_ids": null,
  "rejected_evaluator_ids": null,
  "custom_fields": {
  },
  "form_id": null,
  "board_stage_data": {
    "fields": [

    ],
    "use_elapsed_time": false,
    "sla_elapsed_time": null,
    "sla_elapsed_time_unit": null,
    "use_last_activity": false,
    "sla_last_activity_time": null,
    "sla_last_activity_time_unit": null
  },
  "last_activity_at": "2024-11-08T14:14:39-03:00",
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 1,
  "responsible_id": "coyote-1150",
  "task_state_id": 1,
  "responsible_name": "Coyote 1150",
  "task_state_name": "Board Stage 1342",
  "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 1342",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-1150",
      "team_id": null,
      "assignee_name": "Coyote 1150",
      "team_name": null,
      "queue_position": 1,
      "priority": 1,
      "current_estimate_seconds": 3600,
      "time_worked": 0,
      "estimated_start_date": null,
      "estimate_updated": false,
      "start_date": "2024-11-08T14:14:39-03:00",
      "close_date": null,
      "is_closed": false,
      "reestimate_count": 0,
      "is_working_on": true,
      "automatic_time_worked_updated_at": "2024-11-08T14:14:39-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-915/coyote-1150/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-915/coyote-1150/regular.png",
      "time_worked_not_persisted": 0
    }
  ],
  "follower_ids": [

  ]
}

POST

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

Create assignment and play Task

Parameters

Name	Description	type
id required	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 "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

{
  "id": 1,
  "title": "Bla 270",
  "is_working_on": true,
  "user_id": "coyote-1153",
  "guest_id": null,
  "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": "2024-11-08T14:14:41-03:00",
  "start_date": "2024-11-08T14:14:41-03:00",
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 472",
  "client_id": 1,
  "project_name": "Test project 441",
  "project_group_name": "No group",
  "project_group_id": 1,
  "project_group_is_default": true,
  "project_sub_group_name": "No subgroup",
  "project_sub_group_id": 1,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 500",
  "user_name": "Coyote 1153",
  "guest_name": null,
  "board_name": "Board 442",
  "board_stage_name": "Board Stage 1345",
  "board_stage_description": null,
  "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,
  "parent_ids": [

  ],
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "child_ids": [

  ],
  "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,
  "all_subtasks_time_worked": null,
  "all_subtasks_times_updating": false,
  "all_subtasks_time_total": null,
  "all_subtasks_time_progress": null,
  "current_level": 0,
  "evaluator_ids": null,
  "pending_evaluator_ids": null,
  "approved_evaluator_ids": null,
  "rejected_evaluator_ids": null,
  "custom_fields": {
  },
  "form_id": null,
  "board_stage_data": {
    "fields": [

    ],
    "use_elapsed_time": false,
    "sla_elapsed_time": null,
    "sla_elapsed_time_unit": null,
    "use_last_activity": false,
    "sla_last_activity_time": null,
    "sla_last_activity_time_unit": null
  },
  "last_activity_at": "2024-11-08T14:14:41-03:00",
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 1,
  "responsible_id": "coyote-1152",
  "task_state_id": 1,
  "responsible_name": "Coyote 1152",
  "task_state_name": "Board Stage 1345",
  "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 1345",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-1152",
      "team_id": null,
      "assignee_name": "Coyote 1152",
      "team_name": null,
      "queue_position": 1,
      "priority": 1,
      "current_estimate_seconds": 3600,
      "time_worked": 0,
      "estimated_start_date": null,
      "estimate_updated": false,
      "start_date": "2024-11-08T14:14:41-03:00",
      "close_date": null,
      "is_closed": false,
      "reestimate_count": 0,
      "is_working_on": true,
      "automatic_time_worked_updated_at": "2024-11-08T14:14:41-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-916/coyote-1152/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-916/coyote-1152/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 required	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 "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

{
  "id": 1,
  "title": "Bla 271",
  "is_working_on": false,
  "user_id": "coyote-1155",
  "guest_id": null,
  "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": "2024-11-08T14:14:43-03:00",
  "start_date": "2024-11-08T14:14:44-03:00",
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 473",
  "client_id": 1,
  "project_name": "Test project 442",
  "project_group_name": "No group",
  "project_group_id": 1,
  "project_group_is_default": true,
  "project_sub_group_name": "No subgroup",
  "project_sub_group_id": 1,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 501",
  "user_name": "Coyote 1155",
  "guest_name": null,
  "board_name": "Board 443",
  "board_stage_name": "Board Stage 1348",
  "board_stage_description": null,
  "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,
  "parent_ids": [

  ],
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "child_ids": [

  ],
  "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,
  "all_subtasks_time_worked": null,
  "all_subtasks_times_updating": false,
  "all_subtasks_time_total": null,
  "all_subtasks_time_progress": null,
  "current_level": 0,
  "evaluator_ids": null,
  "pending_evaluator_ids": null,
  "approved_evaluator_ids": null,
  "rejected_evaluator_ids": null,
  "custom_fields": {
  },
  "form_id": null,
  "board_stage_data": {
    "fields": [

    ],
    "use_elapsed_time": false,
    "sla_elapsed_time": null,
    "sla_elapsed_time_unit": null,
    "use_last_activity": false,
    "sla_last_activity_time": null,
    "sla_last_activity_time_unit": null
  },
  "last_activity_at": "2024-11-08T14:14:44-03:00",
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 1,
  "responsible_id": "coyote-1155",
  "task_state_id": 1,
  "responsible_name": "Coyote 1155",
  "task_state_name": "Board Stage 1348",
  "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 1348",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-1154",
      "team_id": null,
      "assignee_name": "Coyote 1154",
      "team_name": null,
      "queue_position": 1,
      "priority": 1,
      "current_estimate_seconds": 3600,
      "time_worked": 0,
      "estimated_start_date": "2024-11-08T14:14:44-03:00",
      "estimate_updated": false,
      "start_date": "2024-11-08T14:14:44-03:00",
      "close_date": null,
      "is_closed": false,
      "reestimate_count": 0,
      "is_working_on": false,
      "automatic_time_worked_updated_at": "2024-11-08T14:14:44-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-917/coyote-1154/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-917/coyote-1154/regular.png",
      "time_worked_not_persisted": 0
    }
  ],
  "follower_ids": [

  ]
}

POST

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

Change a Task board to another

Parameters

Name	Description	type
id required	Task ID	integer
board_id required	ID of the board the task belongs to	integer

Request

Route

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

Headers

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

Body

{
  "board_id": 2
}

cURL

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

Response

Simulated Response

Status

Headers

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

Body

{
  "id": 1,
  "title": "Bla 274",
  "is_working_on": false,
  "user_id": "coyote-1160",
  "guest_id": null,
  "type_id": 1,
  "project_id": 1,
  "team_id": null,
  "board_id": 2,
  "board_stage_id": 3,
  "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": "2024-11-08T14:14:49-03:00",
  "queue_position": 1,
  "created_at": "2024-11-08T14:14:49-03:00",
  "start_date": null,
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 476",
  "client_id": 1,
  "project_name": "Test project 445",
  "project_group_name": "No group",
  "project_group_id": 1,
  "project_group_is_default": true,
  "project_sub_group_name": "No subgroup",
  "project_sub_group_id": 1,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 504",
  "user_name": "Coyote 1160",
  "guest_name": null,
  "board_name": "Board 447",
  "board_stage_name": "Board Stage 1359",
  "board_stage_description": null,
  "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,
  "parent_ids": [

  ],
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "child_ids": [

  ],
  "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,
  "all_subtasks_time_worked": null,
  "all_subtasks_times_updating": false,
  "all_subtasks_time_total": null,
  "all_subtasks_time_progress": null,
  "current_level": 0,
  "evaluator_ids": null,
  "pending_evaluator_ids": null,
  "approved_evaluator_ids": null,
  "rejected_evaluator_ids": null,
  "custom_fields": {
  },
  "form_id": null,
  "board_stage_data": {
    "fields": [

    ],
    "use_elapsed_time": false,
    "sla_elapsed_time": null,
    "sla_elapsed_time_unit": null,
    "use_last_activity": false,
    "sla_last_activity_time": null,
    "sla_last_activity_time_unit": null
  },
  "last_activity_at": "2024-11-08T14:14:49-03:00",
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 1,
  "responsible_id": "coyote-1159",
  "task_state_id": 3,
  "responsible_name": "Coyote 1159",
  "task_state_name": "Board Stage 1359",
  "activities_7_days_ago": 0,
  "repetition_rule_id": null,
  "current_worked_time": 0,
  "estimated_delivery_date_updated": true,
  "last_estimated_at": "2024-11-08T14:14:49-03:00",
  "task_tags": [

  ],
  "approved": null,
  "task_status_id": 3,
  "task_status_name": "Board Stage 1359",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-1159",
      "team_id": null,
      "assignee_name": "Coyote 1159",
      "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": "2024-11-08T14:14:49-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-919/coyote-1159/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-919/coyote-1159/regular.png",
      "time_worked_not_persisted": 0
    }
  ],
  "follower_ids": [

  ]
}

POST

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

Change the project from task to another

Parameters

Name	Description	type
id required	Task ID	integer
project_id	ID of the project the task belongs to	integer

Request

Route

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

Headers

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

Body

{
  "project_id": 1
}

cURL

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

Response

Simulated Response

Status

Headers

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

Body

{
  "id": 1,
  "title": "Bla 275",
  "is_working_on": false,
  "user_id": "coyote-1162",
  "guest_id": null,
  "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": "2024-11-08T14:14:51-03:00",
  "start_date": null,
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 477",
  "client_id": 1,
  "project_name": "Test project 446",
  "project_group_name": "No group",
  "project_group_id": 1,
  "project_group_is_default": true,
  "project_sub_group_name": "No subgroup",
  "project_sub_group_id": 1,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 505",
  "user_name": "Coyote 1162",
  "guest_name": null,
  "board_name": "Board 448",
  "board_stage_name": "Board Stage 1361",
  "board_stage_description": null,
  "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,
  "parent_ids": [

  ],
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "child_ids": [

  ],
  "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,
  "all_subtasks_time_worked": null,
  "all_subtasks_times_updating": false,
  "all_subtasks_time_total": null,
  "all_subtasks_time_progress": null,
  "current_level": 0,
  "evaluator_ids": null,
  "pending_evaluator_ids": null,
  "approved_evaluator_ids": null,
  "rejected_evaluator_ids": null,
  "custom_fields": {
  },
  "form_id": null,
  "board_stage_data": {
    "fields": [

    ],
    "use_elapsed_time": false,
    "sla_elapsed_time": null,
    "sla_elapsed_time_unit": null,
    "use_last_activity": false,
    "sla_last_activity_time": null,
    "sla_last_activity_time_unit": null
  },
  "last_activity_at": "2024-11-08T14:14:51-03:00",
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 1,
  "responsible_id": "coyote-1161",
  "task_state_id": 1,
  "responsible_name": "Coyote 1161",
  "task_state_name": "Board Stage 1361",
  "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 1361",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-1161",
      "team_id": null,
      "assignee_name": "Coyote 1161",
      "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": "2024-11-08T14:14:51-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-920/coyote-1161/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-920/coyote-1161/regular.png",
      "time_worked_not_persisted": 0
    }
  ],
  "follower_ids": [

  ]
}

POST

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

Change the type from task to another

Parameters

Name	Description	type
id required	Task ID	integer
type_id required	ID of the task type	integer

Request

Route

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

Headers

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

Body

{
  "type_id": 1
}

cURL

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

Response

Simulated Response

Status

Headers

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

Body

{
  "id": 1,
  "title": "Bla 277",
  "is_working_on": false,
  "user_id": "coyote-1166",
  "guest_id": null,
  "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": true,
  "estimated_at": "2024-11-08T14:14:55-03:00",
  "queue_position": 1,
  "created_at": "2024-11-08T14:14:55-03:00",
  "start_date": null,
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 479",
  "client_id": 1,
  "project_name": "Test project 449",
  "project_group_name": "No group",
  "project_group_id": 1,
  "project_group_is_default": true,
  "project_sub_group_name": "No subgroup",
  "project_sub_group_id": 1,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 507",
  "user_name": "Coyote 1166",
  "guest_name": null,
  "board_name": "Board 450",
  "board_stage_name": "Board Stage 1367",
  "board_stage_description": null,
  "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,
  "parent_ids": [

  ],
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "child_ids": [

  ],
  "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,
  "all_subtasks_time_worked": null,
  "all_subtasks_times_updating": false,
  "all_subtasks_time_total": null,
  "all_subtasks_time_progress": null,
  "current_level": 0,
  "evaluator_ids": null,
  "pending_evaluator_ids": null,
  "approved_evaluator_ids": null,
  "rejected_evaluator_ids": null,
  "custom_fields": {
  },
  "form_id": null,
  "board_stage_data": {
    "fields": [

    ],
    "use_elapsed_time": false,
    "sla_elapsed_time": null,
    "sla_elapsed_time_unit": null,
    "use_last_activity": false,
    "sla_last_activity_time": null,
    "sla_last_activity_time_unit": null
  },
  "last_activity_at": "2024-11-08T14:14:55-03:00",
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 1,
  "responsible_id": "coyote-1166",
  "task_state_id": 1,
  "responsible_name": "Coyote 1166",
  "task_state_name": "Board Stage 1367",
  "activities_7_days_ago": 0,
  "repetition_rule_id": null,
  "current_worked_time": 0,
  "estimated_delivery_date_updated": true,
  "last_estimated_at": "2024-11-08T14:14:55-03:00",
  "task_tags": [

  ],
  "approved": null,
  "task_status_id": 1,
  "task_status_name": "Board Stage 1367",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-1166",
      "team_id": null,
      "assignee_name": "Coyote 1166",
      "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": "2024-11-08T14:14:55-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-922/coyote-1166/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-922/coyote-1166/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 required	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 "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

{
  "id": 1,
  "title": "Bla 280",
  "is_working_on": false,
  "user_id": "coyote-1172",
  "guest_id": null,
  "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": "2024-11-08T14:15:00-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": "2024-11-08T14:15:00-03:00",
  "start_date": "2024-11-08T14:15:00-03:00",
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 482",
  "client_id": 1,
  "project_name": "Test project 452",
  "project_group_name": "No group",
  "project_group_id": 1,
  "project_group_is_default": true,
  "project_sub_group_name": "No subgroup",
  "project_sub_group_id": 1,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 511",
  "user_name": "Coyote 1172",
  "guest_name": null,
  "board_name": "Board 453",
  "board_stage_name": "Board Stage 1378",
  "board_stage_description": null,
  "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,
  "parent_ids": [

  ],
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "child_ids": [

  ],
  "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,
  "all_subtasks_time_worked": null,
  "all_subtasks_times_updating": false,
  "all_subtasks_time_total": null,
  "all_subtasks_time_progress": null,
  "current_level": 0,
  "evaluator_ids": null,
  "pending_evaluator_ids": null,
  "approved_evaluator_ids": null,
  "rejected_evaluator_ids": null,
  "custom_fields": {
  },
  "form_id": null,
  "board_stage_data": {
    "fields": [

    ],
    "use_elapsed_time": false,
    "sla_elapsed_time": null,
    "sla_elapsed_time_unit": null,
    "use_last_activity": false,
    "sla_last_activity_time": null,
    "sla_last_activity_time_unit": null
  },
  "last_activity_at": "2024-11-08T14:15:00-03:00",
  "priority": null,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 1,
  "responsible_id": "coyote-1171",
  "task_state_id": 3,
  "responsible_name": "Coyote 1171",
  "task_state_name": "Board Stage 1378",
  "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 1378",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-1171",
      "team_id": null,
      "assignee_name": "Coyote 1171",
      "team_name": null,
      "queue_position": null,
      "priority": null,
      "current_estimate_seconds": 3600,
      "time_worked": 0,
      "estimated_start_date": null,
      "estimate_updated": true,
      "start_date": "2024-11-08T14:15:00-03:00",
      "close_date": "2024-11-08T14:15:00-03:00",
      "is_closed": true,
      "reestimate_count": 0,
      "is_working_on": false,
      "automatic_time_worked_updated_at": "2024-11-08T14:15:00-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-925/coyote-1171/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-925/coyote-1171/regular.png",
      "time_worked_not_persisted": 0
    }
  ],
  "follower_ids": [

  ]
}

POST

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

Reopen a Task

Reopen a closed task.

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 "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

{
  "id": 1,
  "title": "Bla 282",
  "is_working_on": false,
  "user_id": "coyote-1178",
  "guest_id": null,
  "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": "2024-11-08T14:15:05-03:00",
  "queue_position": 1,
  "created_at": "2024-11-08T14:15:04-03:00",
  "start_date": "2024-11-08T14:15:04-03:00",
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 484",
  "client_id": 1,
  "project_name": "Test project 454",
  "project_group_name": "No group",
  "project_group_id": 1,
  "project_group_is_default": true,
  "project_sub_group_name": "No subgroup",
  "project_sub_group_id": 1,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 513",
  "user_name": "Coyote 1178",
  "guest_name": null,
  "board_name": "Board 455",
  "board_stage_name": "Board Stage 1383",
  "board_stage_description": null,
  "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,
  "parent_ids": [

  ],
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "child_ids": [

  ],
  "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,
  "all_subtasks_time_worked": null,
  "all_subtasks_times_updating": false,
  "all_subtasks_time_total": null,
  "all_subtasks_time_progress": null,
  "current_level": 0,
  "evaluator_ids": null,
  "pending_evaluator_ids": null,
  "approved_evaluator_ids": null,
  "rejected_evaluator_ids": null,
  "custom_fields": {
  },
  "form_id": null,
  "board_stage_data": {
    "fields": [

    ],
    "use_elapsed_time": false,
    "sla_elapsed_time": null,
    "sla_elapsed_time_unit": null,
    "use_last_activity": false,
    "sla_last_activity_time": null,
    "sla_last_activity_time_unit": null
  },
  "last_activity_at": "2024-11-08T14:15:05-03:00",
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 1,
  "responsible_id": "coyote-1177",
  "task_state_id": 2,
  "responsible_name": "Coyote 1177",
  "task_state_name": "Board Stage 1383",
  "activities_7_days_ago": 0,
  "repetition_rule_id": null,
  "current_worked_time": 0,
  "estimated_delivery_date_updated": true,
  "last_estimated_at": "2024-11-08T14:15:05-03:00",
  "task_tags": [

  ],
  "approved": null,
  "task_status_id": 2,
  "task_status_name": "Board Stage 1383",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-1177",
      "team_id": null,
      "assignee_name": "Coyote 1177",
      "team_name": null,
      "queue_position": 1,
      "priority": 1,
      "current_estimate_seconds": 3600,
      "time_worked": 0,
      "estimated_start_date": null,
      "estimate_updated": false,
      "start_date": "2024-11-08T14:15:04-03:00",
      "close_date": null,
      "is_closed": false,
      "reestimate_count": 0,
      "is_working_on": false,
      "automatic_time_worked_updated_at": "2024-11-08T14:15:04-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-928/coyote-1177/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-928/coyote-1177/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 "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

{
  "id": 4,
  "title": "Bla 291",
  "is_working_on": false,
  "user_id": "coyote-1180",
  "guest_id": null,
  "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": 2,
  "created_at": "2024-11-08T14:15:09-03:00",
  "start_date": null,
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 493",
  "client_id": 4,
  "project_name": "Test project 463",
  "project_group_name": "No group",
  "project_group_id": 4,
  "project_group_is_default": true,
  "project_sub_group_name": "No subgroup",
  "project_sub_group_id": 4,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 522",
  "user_name": "Coyote 1180",
  "guest_name": null,
  "board_name": "Board 464",
  "board_stage_name": "Board Stage 1409",
  "board_stage_description": null,
  "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,
  "parent_ids": [

  ],
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "child_ids": [

  ],
  "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,
  "all_subtasks_time_worked": null,
  "all_subtasks_times_updating": false,
  "all_subtasks_time_total": null,
  "all_subtasks_time_progress": null,
  "current_level": 0,
  "evaluator_ids": null,
  "pending_evaluator_ids": null,
  "approved_evaluator_ids": null,
  "rejected_evaluator_ids": null,
  "custom_fields": {
  },
  "form_id": null,
  "board_stage_data": {
    "fields": [

    ],
    "use_elapsed_time": false,
    "sla_elapsed_time": null,
    "sla_elapsed_time_unit": null,
    "use_last_activity": false,
    "sla_last_activity_time": null,
    "sla_last_activity_time_unit": null
  },
  "last_activity_at": "2024-11-08T14:15:09-03:00",
  "priority": 2,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 4,
  "responsible_id": "coyote-1180",
  "task_state_id": 10,
  "responsible_name": "Coyote 1180",
  "task_state_name": "Board Stage 1409",
  "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 1409",
  "assignments": [
    {
      "id": "1254deb6e4",
      "task_id": 4,
      "assignee_id": "coyote-1180",
      "team_id": null,
      "assignee_name": "Coyote 1180",
      "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": "2024-11-08T14:15:09-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-931/coyote-1180/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-931/coyote-1180/regular.png",
      "time_worked_not_persisted": 0
    }
  ],
  "follower_ids": [

  ]
}

POST

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

Reestimate a Task using assingee_id param

Parameters

Name	Description	type
id required	Task ID	integer
work_seconds required	The new effort (in seconds)	integer
assignee_id	If present only the informed assignee effort will be affected	string

Request

Route

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

Headers

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

Body

{
  "work_seconds": 666,
  "assignee_id": "coyote-1183"
}

cURL

curl "https://runrun.it/api/v1.0/tasks/1/reestimate" -d '{"work_seconds":666,"assignee_id":"coyote-1183"}' -X POST \
	-H "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

{
  "id": 1,
  "title": "Bla 293",
  "is_working_on": false,
  "user_id": "coyote-1184",
  "guest_id": null,
  "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": "2024-11-08T14:15:12-03:00",
  "start_date": null,
  "desired_start_date": null,
  "current_estimate_seconds": 4266,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 495",
  "client_id": 1,
  "project_name": "Test project 465",
  "project_group_name": "No group",
  "project_group_id": 1,
  "project_group_is_default": true,
  "project_sub_group_name": "No subgroup",
  "project_sub_group_id": 1,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 524",
  "user_name": "Coyote 1184",
  "guest_name": null,
  "board_name": "Board 466",
  "board_stage_name": "Board Stage 1415",
  "board_stage_description": null,
  "team_name": null,
  "type_color": "FFFFFF",
  "state": "queued",
  "overdue": "on_schedule",
  "time_worked": 0,
  "time_pending": 4266,
  "time_total": 4266,
  "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": 1,
  "parent_ids": [

  ],
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "child_ids": [

  ],
  "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,
  "all_subtasks_time_worked": null,
  "all_subtasks_times_updating": false,
  "all_subtasks_time_total": null,
  "all_subtasks_time_progress": null,
  "current_level": 0,
  "evaluator_ids": null,
  "pending_evaluator_ids": null,
  "approved_evaluator_ids": null,
  "rejected_evaluator_ids": null,
  "custom_fields": {
  },
  "form_id": null,
  "board_stage_data": {
    "fields": [

    ],
    "use_elapsed_time": false,
    "sla_elapsed_time": null,
    "sla_elapsed_time_unit": null,
    "use_last_activity": false,
    "sla_last_activity_time": null,
    "sla_last_activity_time_unit": null
  },
  "last_activity_at": "2024-11-08T14:15:12-03:00",
  "priority": null,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 1,
  "responsible_id": "coyote-1184",
  "task_state_id": 1,
  "responsible_name": "Coyote 1184",
  "task_state_name": "Board Stage 1415",
  "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 1415",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-1182",
      "team_id": null,
      "assignee_name": "Coyote 1182",
      "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": "2024-11-08T14:15:12-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-933/coyote-1182/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-933/coyote-1182/regular.png",
      "time_worked_not_persisted": 0
    },
    {
      "id": "92a6f5b72",
      "task_id": 1,
      "assignee_id": "coyote-1183",
      "team_id": null,
      "assignee_name": "Coyote 1183",
      "team_name": null,
      "queue_position": 1,
      "priority": 1,
      "current_estimate_seconds": 666,
      "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": "2024-11-08T14:15:12-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-933/coyote-1183/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-933/coyote-1183/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	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 "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

{
  "id": 1,
  "title": "Bla 296",
  "is_working_on": false,
  "user_id": "coyote-1191",
  "guest_id": null,
  "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": "2024-11-08T14:15:16-03:00",
  "start_date": null,
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 498",
  "client_id": 1,
  "project_name": "Test project 468",
  "project_group_name": "No group",
  "project_group_id": 1,
  "project_group_is_default": true,
  "project_sub_group_name": "No subgroup",
  "project_sub_group_id": 1,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 527",
  "user_name": "Coyote 1191",
  "guest_name": null,
  "board_name": "Board 469",
  "board_stage_name": "Board Stage 1424",
  "board_stage_description": null,
  "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,
  "parent_ids": [

  ],
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "child_ids": [

  ],
  "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,
  "all_subtasks_time_worked": null,
  "all_subtasks_times_updating": false,
  "all_subtasks_time_total": null,
  "all_subtasks_time_progress": null,
  "current_level": 0,
  "evaluator_ids": null,
  "pending_evaluator_ids": null,
  "approved_evaluator_ids": null,
  "rejected_evaluator_ids": null,
  "custom_fields": {
  },
  "form_id": null,
  "board_stage_data": {
    "fields": [

    ],
    "use_elapsed_time": false,
    "sla_elapsed_time": null,
    "sla_elapsed_time_unit": null,
    "use_last_activity": false,
    "sla_last_activity_time": null,
    "sla_last_activity_time_unit": null
  },
  "last_activity_at": "2024-11-08T14:15:17-03:00",
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 1,
  "responsible_id": "coyote-1190",
  "task_state_id": 1,
  "responsible_name": "Coyote 1190",
  "task_state_name": "Board Stage 1424",
  "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 1424",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-1190",
      "team_id": null,
      "assignee_name": "Coyote 1190",
      "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": "2024-11-08T14:15:16-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-936/coyote-1190/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-936/coyote-1190/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 "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

{
  "id": 1,
  "title": "Bla 297",
  "is_working_on": false,
  "user_id": "coyote-1193",
  "guest_id": null,
  "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": "2024-11-08T14:15:20-03:00",
  "start_date": null,
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 499",
  "client_id": 1,
  "project_name": "Test project 469",
  "project_group_name": "No group",
  "project_group_id": 1,
  "project_group_is_default": true,
  "project_sub_group_name": "No subgroup",
  "project_sub_group_id": 1,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 528",
  "user_name": "Coyote 1193",
  "guest_name": null,
  "board_name": "Board 470",
  "board_stage_name": "Board Stage 1427",
  "board_stage_description": null,
  "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,
  "parent_ids": [

  ],
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "child_ids": [

  ],
  "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,
  "all_subtasks_time_worked": null,
  "all_subtasks_times_updating": false,
  "all_subtasks_time_total": null,
  "all_subtasks_time_progress": null,
  "current_level": 0,
  "evaluator_ids": null,
  "pending_evaluator_ids": null,
  "approved_evaluator_ids": null,
  "rejected_evaluator_ids": null,
  "custom_fields": {
  },
  "form_id": null,
  "board_stage_data": {
    "fields": [

    ],
    "use_elapsed_time": false,
    "sla_elapsed_time": null,
    "sla_elapsed_time_unit": null,
    "use_last_activity": false,
    "sla_last_activity_time": null,
    "sla_last_activity_time_unit": null
  },
  "last_activity_at": "2024-11-08T14:15:20-03:00",
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 1,
  "responsible_id": "coyote-1192",
  "task_state_id": 1,
  "responsible_name": "Coyote 1192",
  "task_state_name": "Board Stage 1427",
  "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 1427",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-1192",
      "team_id": null,
      "assignee_name": "Coyote 1192",
      "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": "2024-11-08T14:15:20-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-937/coyote-1192/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-937/coyote-1192/regular.png",
      "time_worked_not_persisted": 0
    }
  ],
  "follower_ids": [

  ]
}

POST

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

Complete a workflow step

Parameters

Name	Description	type
id required	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 "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

{
  "id": 1,
  "title": "Bla 302",
  "is_working_on": false,
  "user_id": "coyote-1201",
  "guest_id": null,
  "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": "2024-11-08T14:15:26-03:00",
  "start_date": null,
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 504",
  "client_id": 1,
  "project_name": "Test project 474",
  "project_group_name": "No group",
  "project_group_id": 1,
  "project_group_is_default": true,
  "project_sub_group_name": "No subgroup",
  "project_sub_group_id": 1,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 533",
  "user_name": "Coyote 1201",
  "guest_name": null,
  "board_name": "Board 475",
  "board_stage_name": "Board Stage 1442",
  "board_stage_description": null,
  "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,
  "parent_ids": [

  ],
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "child_ids": [

  ],
  "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,
  "all_subtasks_time_worked": null,
  "all_subtasks_times_updating": false,
  "all_subtasks_time_total": null,
  "all_subtasks_time_progress": null,
  "current_level": 0,
  "evaluator_ids": null,
  "pending_evaluator_ids": null,
  "approved_evaluator_ids": null,
  "rejected_evaluator_ids": null,
  "custom_fields": {
  },
  "form_id": null,
  "board_stage_data": {
    "fields": [

    ],
    "use_elapsed_time": false,
    "sla_elapsed_time": null,
    "sla_elapsed_time_unit": null,
    "use_last_activity": false,
    "sla_last_activity_time": null,
    "sla_last_activity_time_unit": null
  },
  "last_activity_at": "2024-11-08T14:15:26-03:00",
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 1,
  "responsible_id": "coyote-1203",
  "task_state_id": 1,
  "responsible_name": "Coyote 1203",
  "task_state_name": "Board Stage 1442",
  "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 1442",
  "assignments": [
    {
      "id": "92a6f5b72",
      "task_id": 1,
      "assignee_id": "coyote-1203",
      "team_id": null,
      "assignee_name": "Coyote 1203",
      "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": "2024-11-08T14:15:26-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-940/coyote-1203/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-940/coyote-1203/regular.png",
      "time_worked_not_persisted": 0
    }
  ],
  "follower_ids": [
    "coyote-1201"
  ]
}

POST

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

Undo a workflow step

Parameters

Name	Description	type
id required	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 "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

{
  "id": 1,
  "title": "Bla 304",
  "is_working_on": false,
  "user_id": "coyote-1210",
  "guest_id": null,
  "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": "2024-11-08T14:15:31-03:00",
  "start_date": null,
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 506",
  "client_id": 1,
  "project_name": "Test project 476",
  "project_group_name": "No group",
  "project_group_id": 1,
  "project_group_is_default": true,
  "project_sub_group_name": "No subgroup",
  "project_sub_group_id": 1,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 535",
  "user_name": "Coyote 1210",
  "guest_name": null,
  "board_name": "Board 477",
  "board_stage_name": "Board Stage 1448",
  "board_stage_description": null,
  "team_name": "Test team 68",
  "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,
  "parent_ids": [

  ],
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "child_ids": [

  ],
  "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,
  "all_subtasks_time_worked": null,
  "all_subtasks_times_updating": false,
  "all_subtasks_time_total": null,
  "all_subtasks_time_progress": null,
  "current_level": 0,
  "evaluator_ids": null,
  "pending_evaluator_ids": null,
  "approved_evaluator_ids": null,
  "rejected_evaluator_ids": null,
  "custom_fields": {
  },
  "form_id": null,
  "board_stage_data": {
    "fields": [

    ],
    "use_elapsed_time": false,
    "sla_elapsed_time": null,
    "sla_elapsed_time_unit": null,
    "use_last_activity": false,
    "sla_last_activity_time": null,
    "sla_last_activity_time_unit": null
  },
  "last_activity_at": "2024-11-08T14:15:31-03:00",
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 1,
  "responsible_id": "coyote-1209",
  "task_state_id": 1,
  "responsible_name": "Coyote 1209",
  "task_state_name": "Board Stage 1448",
  "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 1448",
  "assignments": [
    {
      "id": "dbfa7092b",
      "task_id": 1,
      "assignee_id": "coyote-1209",
      "team_id": 1,
      "assignee_name": "Coyote 1209",
      "team_name": "Test team 68",
      "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": "2024-11-08T14:15:31-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-944/coyote-1209/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-944/coyote-1209/regular.png",
      "time_worked_not_persisted": 0
    }
  ],
  "follower_ids": [
    "coyote-1207",
    "coyote-1209"
  ]
}

POST

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

Mark a task as urgent

Parameters

Name	Description	type
id required	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 "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

{
  "id": 1,
  "title": "Bla 310",
  "is_working_on": false,
  "user_id": "coyote-1225",
  "guest_id": null,
  "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": "2024-11-08T14:15:42-03:00",
  "start_date": null,
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 512",
  "client_id": 1,
  "project_name": "Test project 482",
  "project_group_name": "No group",
  "project_group_id": 1,
  "project_group_is_default": true,
  "project_sub_group_name": "No subgroup",
  "project_sub_group_id": 1,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 541",
  "user_name": "Coyote 1225",
  "guest_name": null,
  "board_name": "Board 483",
  "board_stage_name": "Board Stage 1466",
  "board_stage_description": null,
  "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,
  "parent_ids": [

  ],
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "child_ids": [

  ],
  "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,
  "all_subtasks_time_worked": null,
  "all_subtasks_times_updating": false,
  "all_subtasks_time_total": null,
  "all_subtasks_time_progress": null,
  "current_level": 0,
  "evaluator_ids": null,
  "pending_evaluator_ids": null,
  "approved_evaluator_ids": null,
  "rejected_evaluator_ids": null,
  "custom_fields": {
  },
  "form_id": null,
  "board_stage_data": {
    "fields": [

    ],
    "use_elapsed_time": false,
    "sla_elapsed_time": null,
    "sla_elapsed_time_unit": null,
    "use_last_activity": false,
    "sla_last_activity_time": null,
    "sla_last_activity_time_unit": null
  },
  "last_activity_at": "2024-11-08T14:15:42-03:00",
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 1,
  "responsible_id": "coyote-1224",
  "task_state_id": 1,
  "responsible_name": "Coyote 1224",
  "task_state_name": "Board Stage 1466",
  "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 1466",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-1224",
      "team_id": null,
      "assignee_name": "Coyote 1224",
      "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": "2024-11-08T14:15:42-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-951/coyote-1224/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-951/coyote-1224/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 required	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 "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

{
  "id": 1,
  "title": "Bla 311",
  "is_working_on": false,
  "user_id": "coyote-1227",
  "guest_id": null,
  "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": "2024-11-08T14:15:44-03:00",
  "start_date": null,
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 513",
  "client_id": 1,
  "project_name": "Test project 483",
  "project_group_name": "No group",
  "project_group_id": 1,
  "project_group_is_default": true,
  "project_sub_group_name": "No subgroup",
  "project_sub_group_id": 1,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 542",
  "user_name": "Coyote 1227",
  "guest_name": null,
  "board_name": "Board 484",
  "board_stage_name": "Board Stage 1469",
  "board_stage_description": null,
  "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,
  "parent_ids": [

  ],
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "child_ids": [

  ],
  "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,
  "all_subtasks_time_worked": null,
  "all_subtasks_times_updating": false,
  "all_subtasks_time_total": null,
  "all_subtasks_time_progress": null,
  "current_level": 0,
  "evaluator_ids": null,
  "pending_evaluator_ids": null,
  "approved_evaluator_ids": null,
  "rejected_evaluator_ids": null,
  "custom_fields": {
  },
  "form_id": null,
  "board_stage_data": {
    "fields": [

    ],
    "use_elapsed_time": false,
    "sla_elapsed_time": null,
    "sla_elapsed_time_unit": null,
    "use_last_activity": false,
    "sla_last_activity_time": null,
    "sla_last_activity_time_unit": null
  },
  "last_activity_at": "2024-11-08T14:15:44-03:00",
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 1,
  "responsible_id": "coyote-1226",
  "task_state_id": 1,
  "responsible_name": "Coyote 1226",
  "task_state_name": "Board Stage 1469",
  "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 1469",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-1226",
      "team_id": null,
      "assignee_name": "Coyote 1226",
      "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": "2024-11-08T14:15:44-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-952/coyote-1226/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-952/coyote-1226/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	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-1229",
      "team_id": 1
    }
  ]
}

cURL

curl "https://runrun.it/api/v1.0/tasks/1/create_assignments" -d '{"assignments":[{"assignee_id":"coyote-1229","team_id":1}]}' -X POST \
	-H "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

{
  "id": 1,
  "title": "Bla 312",
  "is_working_on": false,
  "user_id": "coyote-1231",
  "guest_id": null,
  "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": "2024-11-08T14:15:46-03:00",
  "start_date": null,
  "desired_start_date": null,
  "current_estimate_seconds": 7200,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 514",
  "client_id": 1,
  "project_name": "Test project 484",
  "project_group_name": "No group",
  "project_group_id": 1,
  "project_group_is_default": true,
  "project_sub_group_name": "No subgroup",
  "project_sub_group_id": 1,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 543",
  "user_name": "Coyote 1231",
  "guest_name": null,
  "board_name": "Board 485",
  "board_stage_name": "Board Stage 1472",
  "board_stage_description": null,
  "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,
  "parent_ids": [

  ],
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "child_ids": [

  ],
  "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,
  "all_subtasks_time_worked": null,
  "all_subtasks_times_updating": false,
  "all_subtasks_time_total": null,
  "all_subtasks_time_progress": null,
  "current_level": 0,
  "evaluator_ids": null,
  "pending_evaluator_ids": null,
  "approved_evaluator_ids": null,
  "rejected_evaluator_ids": null,
  "custom_fields": {
  },
  "form_id": null,
  "board_stage_data": {
    "fields": [

    ],
    "use_elapsed_time": false,
    "sla_elapsed_time": null,
    "sla_elapsed_time_unit": null,
    "use_last_activity": false,
    "sla_last_activity_time": null,
    "sla_last_activity_time_unit": null
  },
  "last_activity_at": "2024-11-08T14:15:46-03:00",
  "priority": null,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 1,
  "responsible_id": "coyote-1228",
  "task_state_id": 1,
  "responsible_name": "Coyote 1228",
  "task_state_name": "Board Stage 1472",
  "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 1472",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-1228",
      "team_id": null,
      "assignee_name": "Coyote 1228",
      "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": "2024-11-08T14:15:46-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-953/coyote-1228/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-953/coyote-1228/regular.png",
      "time_worked_not_persisted": 0
    },
    {
      "id": "92a6f5b72",
      "task_id": 1,
      "assignee_id": "coyote-1229",
      "team_id": 1,
      "assignee_name": "Coyote 1229",
      "team_name": "Test team 69",
      "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": "2024-11-08T14:15:46-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-953/coyote-1229/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-953/coyote-1229/regular.png",
      "time_worked_not_persisted": 0
    }
  ],
  "follower_ids": [

  ]
}

POST

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

Move a task to top

Parameters

Name	Description	type
id required	Task ID	integer

Request

Route

POST /api/v1.0/tasks/2/move_to_top

Headers

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

cURL

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

Response

Simulated Response

Status

Headers

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

Body

{
  "id": 2,
  "title": "Bla 316",
  "is_working_on": false,
  "user_id": "coyote-1242",
  "guest_id": null,
  "type_id": 2,
  "project_id": 2,
  "team_id": null,
  "board_id": 3,
  "board_stage_id": 4,
  "board_stage_position": 35184372088832,
  "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": "2024-11-08T14:15:53-03:00",
  "start_date": null,
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 518",
  "client_id": 2,
  "project_name": "Test project 488",
  "project_group_name": "No group",
  "project_group_id": 2,
  "project_group_is_default": true,
  "project_sub_group_name": "No subgroup",
  "project_sub_group_id": 2,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 547",
  "user_name": "Coyote 1242",
  "guest_name": null,
  "board_name": "Board 490",
  "board_stage_name": "Board Stage 1484",
  "board_stage_description": null,
  "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,
  "parent_ids": [

  ],
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "child_ids": [

  ],
  "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,
  "all_subtasks_time_worked": null,
  "all_subtasks_times_updating": false,
  "all_subtasks_time_total": null,
  "all_subtasks_time_progress": null,
  "current_level": 0,
  "evaluator_ids": null,
  "pending_evaluator_ids": null,
  "approved_evaluator_ids": null,
  "rejected_evaluator_ids": null,
  "custom_fields": {
  },
  "form_id": null,
  "board_stage_data": {
    "fields": [

    ],
    "use_elapsed_time": false,
    "sla_elapsed_time": null,
    "sla_elapsed_time_unit": null,
    "use_last_activity": false,
    "sla_last_activity_time": null,
    "sla_last_activity_time_unit": null
  },
  "last_activity_at": "2024-11-08T14:15:53-03:00",
  "priority": 2,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 2,
  "responsible_id": "coyote-1240",
  "task_state_id": 4,
  "responsible_name": "Coyote 1240",
  "task_state_name": "Board Stage 1484",
  "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 1484",
  "assignments": [
    {
      "id": "92a6f5b72",
      "task_id": 2,
      "assignee_id": "coyote-1240",
      "team_id": null,
      "assignee_name": "Coyote 1240",
      "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": "2024-11-08T14:15:53-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-959/coyote-1240/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-959/coyote-1240/regular.png",
      "time_worked_not_persisted": 0
    }
  ],
  "follower_ids": [

  ]
}

POST

/api/v1.0/tasks/clone

Clone a task

POST

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

Move a task to next stage

Parameters

Name	Description	type
id required	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 "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

{
  "id": 1,
  "title": "Bla 318",
  "is_working_on": false,
  "user_id": "coyote-1246",
  "guest_id": null,
  "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": "2024-11-08T14:15:57-03:00",
  "queue_position": 1,
  "created_at": "2024-11-08T14:15:57-03:00",
  "start_date": null,
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 520",
  "client_id": 1,
  "project_name": "Test project 490",
  "project_group_name": "No group",
  "project_group_id": 1,
  "project_group_is_default": true,
  "project_sub_group_name": "No subgroup",
  "project_sub_group_id": 1,
  "project_sub_group_is_default": true,
  "type_name": "TaskType 549",
  "user_name": "Coyote 1246",
  "guest_name": null,
  "board_name": "Board 492",
  "board_stage_name": "Board Stage 1495",
  "board_stage_description": null,
  "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,
  "parent_ids": [

  ],
  "opened_parent_ids": [

  ],
  "parents_max_desired_date": null,
  "child_ids": [

  ],
  "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,
  "all_subtasks_time_worked": null,
  "all_subtasks_times_updating": false,
  "all_subtasks_time_total": null,
  "all_subtasks_time_progress": null,
  "current_level": 0,
  "evaluator_ids": null,
  "pending_evaluator_ids": null,
  "approved_evaluator_ids": null,
  "rejected_evaluator_ids": null,
  "custom_fields": {
  },
  "form_id": null,
  "board_stage_data": {
    "fields": [

    ],
    "use_elapsed_time": false,
    "sla_elapsed_time": null,
    "sla_elapsed_time_unit": null,
    "use_last_activity": false,
    "sla_last_activity_time": null,
    "sla_last_activity_time_unit": null
  },
  "last_activity_at": "2024-11-08T14:15:57-03:00",
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 1,
  "responsible_id": "coyote-1245",
  "task_state_id": 2,
  "responsible_name": "Coyote 1245",
  "task_state_name": "Board Stage 1495",
  "activities_7_days_ago": 0,
  "repetition_rule_id": null,
  "current_worked_time": 0,
  "estimated_delivery_date_updated": true,
  "last_estimated_at": "2024-11-08T14:15:57-03:00",
  "task_tags": [

  ],
  "approved": null,
  "task_status_id": 2,
  "task_status_name": "Board Stage 1495",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-1245",
      "team_id": null,
      "assignee_name": "Coyote 1245",
      "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": "2024-11-08T14:15:57-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-961/coyote-1245/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-961/coyote-1245/regular.png",
      "time_worked_not_persisted": 0
    }
  ],
  "follower_ids": [

  ]
}

GET

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

Get answers to the form which created the task

GET

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

List fields from task's board

Request

Route

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

Headers

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

cURL

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

Response

Simulated Response

Status

Headers

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

Body

[
  {
    "id": "board",
    "label": "Board",
    "field_type": "board",
    "details": {
    },
    "position": 70368744177664,
    "description": null,
    "status": "active",
    "category": "default",
    "board_id": 1,
    "created_at": "2024-11-08T14:16:22-03:00"
  },
  {
    "id": "board_stage",
    "label": "Stage",
    "field_type": "board_stage",
    "details": {
    },
    "position": 140737488355328,
    "description": null,
    "status": "active",
    "category": "default",
    "board_id": 1,
    "created_at": "2024-11-08T14:16:22-03:00"
  },
  {
    "id": "board_stage_elapsed_time",
    "label": "Elapsed stage time",
    "field_type": "board_stage_elapsed_time",
    "details": {
    },
    "position": 211106232532992,
    "description": null,
    "status": "active",
    "category": "default",
    "board_id": 1,
    "created_at": "2024-11-08T14:16:22-03:00"
  },
  {
    "id": "last_activity",
    "label": "Last update",
    "field_type": "last_activity",
    "details": {
    },
    "position": 281474976710656,
    "description": null,
    "status": "active",
    "category": "default",
    "board_id": 1,
    "created_at": "2024-11-08T14:16:22-03:00"
  },
  {
    "id": "tags",
    "label": "Tags",
    "field_type": "tags",
    "details": {
    },
    "position": 351843720888320,
    "description": null,
    "status": "active",
    "category": "default",
    "board_id": 1,
    "created_at": "2024-11-08T14:16:22-03:00"
  },
  {
    "id": "task_type",
    "label": "Type",
    "field_type": "task_type",
    "details": {
    },
    "position": 422212465065984,
    "description": null,
    "status": "active",
    "category": "default",
    "board_id": 1,
    "created_at": "2024-11-08T14:16:22-03:00"
  },
  {
    "id": "project",
    "label": "Project",
    "field_type": "project",
    "details": {
    },
    "position": 492581209243648,
    "description": null,
    "status": "active",
    "category": "default",
    "board_id": 1,
    "created_at": "2024-11-08T14:16:22-03:00"
  },
  {
    "id": "custom_2",
    "label": null,
    "field_type": "divider",
    "details": {
    },
    "position": 562949953421312,
    "description": null,
    "status": "active",
    "category": "custom",
    "board_id": 1,
    "created_at": "2024-11-08T14:16:22-03:00"
  },
  {
    "id": "desired_start_date",
    "label": "Desired start",
    "field_type": "date",
    "details": {
      "include_time": true
    },
    "position": 633318697598976,
    "description": null,
    "status": "active",
    "category": "default",
    "board_id": 1,
    "created_at": "2024-11-08T14:16:22-03:00"
  },
  {
    "id": "desired_delivery_date",
    "label": "Desired due date",
    "field_type": "date",
    "details": {
      "include_time": true
    },
    "position": 703687441776640,
    "description": null,
    "status": "active",
    "category": "default",
    "board_id": 1,
    "created_at": "2024-11-08T14:16:22-03:00"
  },
  {
    "id": "repetition_rule",
    "label": "Repetition",
    "field_type": "repetition_rule",
    "details": {
    },
    "position": 774056185954304,
    "description": null,
    "status": "active",
    "category": "default",
    "board_id": 1,
    "created_at": "2024-11-08T14:16:22-03:00"
  },
  {
    "id": "start_date",
    "label": "Start date",
    "field_type": "date",
    "details": {
      "include_time": true
    },
    "position": 844424930131968,
    "description": null,
    "status": "active",
    "category": "default",
    "board_id": 1,
    "created_at": "2024-11-08T14:16:22-03:00"
  },
  {
    "id": "close_date",
    "label": "Delivery date",
    "field_type": "date",
    "details": {
      "include_time": true
    },
    "position": 914793674309632,
    "description": null,
    "status": "active",
    "category": "default",
    "board_id": 1,
    "created_at": "2024-11-08T14:16:22-03:00"
  },
  {
    "id": "custom_3",
    "label": null,
    "field_type": "divider",
    "details": {
    },
    "position": 985162418487296,
    "description": null,
    "status": "active",
    "category": "custom",
    "board_id": 1,
    "created_at": "2024-11-08T14:16:22-03:00"
  },
  {
    "id": "time",
    "label": "Time",
    "field_type": "time",
    "details": {
    },
    "position": 1055531162664960,
    "description": null,
    "status": "active",
    "category": "default",
    "board_id": 1,
    "created_at": "2024-11-08T14:16:22-03:00"
  },
  {
    "id": "custom_4",
    "label": null,
    "field_type": "divider",
    "details": {
    },
    "position": 1125899906842624,
    "description": null,
    "status": "active",
    "category": "custom",
    "board_id": 1,
    "created_at": "2024-11-08T14:16:22-03:00"
  },
  {
    "id": "followers",
    "label": "Followers",
    "field_type": "followers",
    "details": {
    },
    "position": 1196268651020288,
    "description": null,
    "status": "active",
    "category": "default",
    "board_id": 1,
    "created_at": "2024-11-08T14:16:22-03:00"
  },
  {
    "id": "checklist",
    "label": "Checklist",
    "field_type": "checklist",
    "details": {
    },
    "position": 1266637395197952,
    "description": null,
    "status": "active",
    "category": "default",
    "board_id": 1,
    "created_at": "2024-11-08T14:16:22-03:00"
  },
  {
    "id": "points",
    "label": "Points",
    "field_type": "numeric",
    "details": {
      "prefix": null,
      "suffix": null,
      "precision": 0
    },
    "position": 1337006139375616,
    "description": null,
    "status": "active",
    "category": "default",
    "board_id": 1,
    "created_at": "2024-11-08T14:16:22-03:00"
  },
  {
    "id": "custom_1",
    "label": "Nickname",
    "field_type": "short_text",
    "details": {
    },
    "position": 1407374883553280,
    "description": null,
    "status": "active",
    "category": "custom",
    "board_id": 1,
    "created_at": "2024-11-08T14:16:22-03:00"
  }
]

Teams

GET

/api/v1.0/teams

List teams

Parameters

Name	Description	type
sort	Sort by column	string
sort_dir	Sort direction ('asc' or 'desc')	string
search_term	Filter by term	string
filter_id	Filter by an existing filter	integer

Request

Route

GET /api/v1.0/teams

Headers

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

cURL

curl -g "https://runrun.it/api/v1.0/teams" -X GET \
	-H "Version: HTTP/1.0" \
	-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 team	integer
name	Name of the team	string
leader_id	Id of the user team leader	string
leader_name	Name of the user team leader	string
cost_center	Cost center	string
user_ids	Ids of team members	array
master_user_id	[Deprecated] Use leader_id	string
master_user_name	[Deprecated] Use leader_name	string

Status

Headers

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

Body

[
  {
    "id": 1,
    "name": "Team 1",
    "leader_id": "coyote-1273",
    "leader_name": "Coyote 1273",
    "cost_center": null,
    "user_ids": [
      "coyote-1273"
    ],
    "master_user_id": "coyote-1273",
    "master_user_name": "Coyote 1273"
  }
]

GET

/api/v1.0/teams/:id

Show a team

POST

/api/v1.0/teams

Create a team

PUT

/api/v1.0/teams/:id

Update a team

DELETE

/api/v1.0/teams/:id

Destroy a team

POST

/api/v1.0/teams/:id/add_member

Add a user to a team

POST

/api/v1.0/teams/:id/remove_member

Remove a user from team

Time Worked

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, for example group_by=project_id,project_group_id,project_subgroup_id,task_id,user_id,date. 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: date, client_id, project_group_id, project_id, project_sub_group_id, task_id, task_status_id, team_id, type_id, user_id	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 -g "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 "Version: HTTP/1.0" \
	-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

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 309",
      "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 340",
      "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
    }
  ]
}

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 -g "https://runrun.it/api/v1.0/users" -X GET \
	-H "Version: HTTP/1.0" \
	-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 RR Starter certification	boolean
is_certified_expert	Whether the user has passed RR Expert 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
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
is_eligible_to_access_reports	User can access enterprise reports	boolean
is_eligible_to_whatsapp	User can access whatsapp integration	boolean
theme	[Deprecated] Use preferences.theme	string
task_list_background_image_url	[Deprecated] Use preferences.task_list_background_image_url	string
skip_time_adjust_on_task_assignment_deliver	[Deprecated] Use preferences.skip_time_adjust_on_task_assignment_deliver	boolean
time_tracking_mode	[Deprecated] Use 'time_tracking_mode' from enterprise	string

Status

Headers

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

Body

[
  {
    "id": "coyote-1294",
    "name": "Coyote 1294",
    "email": "coyote1288@acme.foo",
    "avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-993/coyote-1294/mini.png",
    "avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-993/coyote-1294/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": "2024-11-08T14:16:38-03:00",
    "in_company_since": null,
    "is_certified": false,
    "is_certified_expert": false,
    "language": "en-US",
    "alt_id": "55a977a86f496b39a77953abcc62ac83",
    "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,
    "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": [

    ],
    "is_eligible_to_access_reports": false,
    "is_eligible_to_whatsapp": false,
    "theme": "light",
    "task_list_background_image_url": null,
    "skip_time_adjust_on_task_assignment_deliver": false,
    "time_tracking_mode": "manual",
    "preferences": {
      "theme": "light",
      "task_list_background_image_url": null,
      "skip_time_adjust_on_task_assignment_deliver": false,
      "skip_move_task_to_next_board_stage_suggestion": false
    }
  },
  {
    "id": "coyote-1293",
    "name": "Coyote 1293",
    "email": "coyote1287@acme.foo",
    "avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-993/coyote-1293/mini.png",
    "avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-993/coyote-1293/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": true,
    "time_zone": "America/Sao_Paulo",
    "position": null,
    "on_vacation": false,
    "birthday": null,
    "phone": null,
    "gender": null,
    "marital_status": null,
    "created_at": "2024-11-08T14:16:37-03:00",
    "in_company_since": null,
    "is_certified": false,
    "is_certified_expert": false,
    "language": "en-US",
    "alt_id": "5e7b21acee54e1d28c3cebc271c5e4ea",
    "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,
    "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": [

    ],
    "is_eligible_to_access_reports": false,
    "is_eligible_to_whatsapp": false,
    "theme": "light",
    "task_list_background_image_url": null,
    "skip_time_adjust_on_task_assignment_deliver": false,
    "time_tracking_mode": "manual",
    "preferences": {
      "theme": "light",
      "task_list_background_image_url": null,
      "skip_time_adjust_on_task_assignment_deliver": false,
      "skip_move_task_to_next_board_stage_suggestion": false
    }
  }
]

GET

/api/v1.0/users/:user_id

Get a user by id

Parameters

Name	Description	type
user_id required	User's ID	string

Request

Route

GET /api/v1.0/users/coyote-1319

Headers

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

cURL

curl -g "https://runrun.it/api/v1.0/users/coyote-1319" -X GET \
	-H "Version: HTTP/1.0" \
	-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 RR Starter certification	boolean
is_certified_expert	Whether the user has passed RR Expert 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
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
is_eligible_to_access_reports	User can access enterprise reports	boolean
is_eligible_to_whatsapp	User can access whatsapp integration	boolean
theme	[Deprecated] Use preferences.theme	string
task_list_background_image_url	[Deprecated] Use preferences.task_list_background_image_url	string
skip_time_adjust_on_task_assignment_deliver	[Deprecated] Use preferences.skip_time_adjust_on_task_assignment_deliver	boolean
time_tracking_mode	[Deprecated] Use 'time_tracking_mode' from enterprise	string

Status

Headers

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

Body

{
  "id": "coyote-1319",
  "name": "Coyote 1319",
  "email": "coyote1313@acme.foo",
  "avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-1000/coyote-1319/mini.png",
  "avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-1000/coyote-1319/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": "2024-11-08T14:16:51-03:00",
  "in_company_since": null,
  "is_certified": false,
  "is_certified_expert": false,
  "language": "en-US",
  "alt_id": "e94cd23050b554857b0c8a599b168f7f",
  "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,
  "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": [

  ],
  "is_eligible_to_access_reports": false,
  "is_eligible_to_whatsapp": false,
  "theme": "light",
  "task_list_background_image_url": null,
  "skip_time_adjust_on_task_assignment_deliver": false,
  "time_tracking_mode": "manual",
  "preferences": {
    "theme": "light",
    "task_list_background_image_url": null,
    "skip_time_adjust_on_task_assignment_deliver": false,
    "skip_move_task_to_next_board_stage_suggestion": false
  }
}

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 "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

{
  "id": "jon-smith",
  "name": "Jon Smith",
  "email": "john@smith.com",
  "avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-1001/jon-smith/0be7880343fd6f44e2bd968b5cb806e9mini.png",
  "avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-1001/jon-smith/0be7880343fd6f44e2bd968b5cb806e9regular.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": "2024-11-08T14:16:52-03:00",
  "in_company_since": null,
  "is_certified": false,
  "is_certified_expert": false,
  "language": "en-US",
  "alt_id": "ad288cdf7029231cc2e0b95e763d8148",
  "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,
  "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": [

  ],
  "is_eligible_to_access_reports": false,
  "is_eligible_to_whatsapp": false,
  "theme": "light",
  "task_list_background_image_url": null,
  "skip_time_adjust_on_task_assignment_deliver": false,
  "time_tracking_mode": "manual",
  "preferences": {
    "theme": "light",
    "task_list_background_image_url": null,
    "skip_time_adjust_on_task_assignment_deliver": false,
    "skip_move_task_to_next_board_stage_suggestion": false
  }
}

PUT

/api/v1.0/users/:id

Update a user

Parameters

Name	Description	type
user[id] required	User's ID	string

Request

Route

PUT /api/v1.0/users/jon-smith

Headers

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

Body

{
  "user": {
    "name": "Steve Jobs",
    "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 "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

{
  "id": "jon-smith",
  "name": "Steve Jobs",
  "email": "coyote1328@acme.foo",
  "avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-1010/jon-smith/mini.png",
  "avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-1010/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": true,
  "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,
  "is_certified_expert": false,
  "language": "en-US",
  "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,
  "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": [

  ],
  "is_eligible_to_access_reports": false,
  "is_eligible_to_whatsapp": false,
  "theme": "light",
  "task_list_background_image_url": null,
  "skip_time_adjust_on_task_assignment_deliver": false,
  "time_tracking_mode": "manual",
  "preferences": {
    "theme": "light",
    "task_list_background_image_url": null,
    "skip_time_adjust_on_task_assignment_deliver": false,
    "skip_move_task_to_next_board_stage_suggestion": false
  }
}

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 -g "https://runrun.it/api/v1.0/users" -X GET \
	-H "Version: HTTP/1.0" \
	-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 RR Starter certification	boolean
is_certified_expert	Whether the user has passed RR Expert 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
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
is_eligible_to_access_reports	User can access enterprise reports	boolean
is_eligible_to_whatsapp	User can access whatsapp integration	boolean
theme	[Deprecated] Use preferences.theme	string
task_list_background_image_url	[Deprecated] Use preferences.task_list_background_image_url	string
skip_time_adjust_on_task_assignment_deliver	[Deprecated] Use preferences.skip_time_adjust_on_task_assignment_deliver	boolean
time_tracking_mode	[Deprecated] Use 'time_tracking_mode' from enterprise	string

Status

Headers

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

Body

[
  {
    "id": "coyote-1294",
    "name": "Coyote 1294",
    "email": "coyote1288@acme.foo",
    "avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-993/coyote-1294/mini.png",
    "avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-993/coyote-1294/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": "2024-11-08T14:16:38-03:00",
    "in_company_since": null,
    "is_certified": false,
    "is_certified_expert": false,
    "language": "en-US",
    "alt_id": "55a977a86f496b39a77953abcc62ac83",
    "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,
    "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": [

    ],
    "is_eligible_to_access_reports": false,
    "is_eligible_to_whatsapp": false,
    "theme": "light",
    "task_list_background_image_url": null,
    "skip_time_adjust_on_task_assignment_deliver": false,
    "time_tracking_mode": "manual",
    "preferences": {
      "theme": "light",
      "task_list_background_image_url": null,
      "skip_time_adjust_on_task_assignment_deliver": false,
      "skip_move_task_to_next_board_stage_suggestion": false
    }
  },
  {
    "id": "coyote-1293",
    "name": "Coyote 1293",
    "email": "coyote1287@acme.foo",
    "avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-993/coyote-1293/mini.png",
    "avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-993/coyote-1293/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": true,
    "time_zone": "America/Sao_Paulo",
    "position": null,
    "on_vacation": false,
    "birthday": null,
    "phone": null,
    "gender": null,
    "marital_status": null,
    "created_at": "2024-11-08T14:16:37-03:00",
    "in_company_since": null,
    "is_certified": false,
    "is_certified_expert": false,
    "language": "en-US",
    "alt_id": "5e7b21acee54e1d28c3cebc271c5e4ea",
    "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,
    "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": [

    ],
    "is_eligible_to_access_reports": false,
    "is_eligible_to_whatsapp": false,
    "theme": "light",
    "task_list_background_image_url": null,
    "skip_time_adjust_on_task_assignment_deliver": false,
    "time_tracking_mode": "manual",
    "preferences": {
      "theme": "light",
      "task_list_background_image_url": null,
      "skip_time_adjust_on_task_assignment_deliver": false,
      "skip_move_task_to_next_board_stage_suggestion": false
    }
  }
]

GET

/api/v1.0/users/:user_id

Get a user by id

Parameters

Name	Description	type
user_id required	User's ID	string

Request

Route

GET /api/v1.0/users/coyote-1319

Headers

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

cURL

curl -g "https://runrun.it/api/v1.0/users/coyote-1319" -X GET \
	-H "Version: HTTP/1.0" \
	-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 RR Starter certification	boolean
is_certified_expert	Whether the user has passed RR Expert 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
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
is_eligible_to_access_reports	User can access enterprise reports	boolean
is_eligible_to_whatsapp	User can access whatsapp integration	boolean
theme	[Deprecated] Use preferences.theme	string
task_list_background_image_url	[Deprecated] Use preferences.task_list_background_image_url	string
skip_time_adjust_on_task_assignment_deliver	[Deprecated] Use preferences.skip_time_adjust_on_task_assignment_deliver	boolean
time_tracking_mode	[Deprecated] Use 'time_tracking_mode' from enterprise	string

Status

Headers

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

Body

{
  "id": "coyote-1319",
  "name": "Coyote 1319",
  "email": "coyote1313@acme.foo",
  "avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-1000/coyote-1319/mini.png",
  "avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-1000/coyote-1319/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": "2024-11-08T14:16:51-03:00",
  "in_company_since": null,
  "is_certified": false,
  "is_certified_expert": false,
  "language": "en-US",
  "alt_id": "e94cd23050b554857b0c8a599b168f7f",
  "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,
  "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": [

  ],
  "is_eligible_to_access_reports": false,
  "is_eligible_to_whatsapp": false,
  "theme": "light",
  "task_list_background_image_url": null,
  "skip_time_adjust_on_task_assignment_deliver": false,
  "time_tracking_mode": "manual",
  "preferences": {
    "theme": "light",
    "task_list_background_image_url": null,
    "skip_time_adjust_on_task_assignment_deliver": false,
    "skip_move_task_to_next_board_stage_suggestion": false
  }
}

POST

/api/v1.0/users

Create a user

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 "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

{
  "id": "jon-smith",
  "name": "Jon Smith",
  "email": "john@smith.com",
  "avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-1001/jon-smith/0be7880343fd6f44e2bd968b5cb806e9mini.png",
  "avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-1001/jon-smith/0be7880343fd6f44e2bd968b5cb806e9regular.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": "2024-11-08T14:16:52-03:00",
  "in_company_since": null,
  "is_certified": false,
  "is_certified_expert": false,
  "language": "en-US",
  "alt_id": "ad288cdf7029231cc2e0b95e763d8148",
  "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,
  "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": [

  ],
  "is_eligible_to_access_reports": false,
  "is_eligible_to_whatsapp": false,
  "theme": "light",
  "task_list_background_image_url": null,
  "skip_time_adjust_on_task_assignment_deliver": false,
  "time_tracking_mode": "manual",
  "preferences": {
    "theme": "light",
    "task_list_background_image_url": null,
    "skip_time_adjust_on_task_assignment_deliver": false,
    "skip_move_task_to_next_board_stage_suggestion": false
  }
}

PUT

/api/v1.0/users/:id

Update a user

Parameters

Name	Description	type
user[id] required	User's ID	string

Request

Route

PUT /api/v1.0/users/jon-smith

Headers

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

Body

{
  "user": {
    "name": "Steve Jobs",
    "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 "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

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

Body

{
  "id": "jon-smith",
  "name": "Steve Jobs",
  "email": "coyote1328@acme.foo",
  "avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-1010/jon-smith/mini.png",
  "avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-1010/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": true,
  "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,
  "is_certified_expert": false,
  "language": "en-US",
  "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,
  "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": [

  ],
  "is_eligible_to_access_reports": false,
  "is_eligible_to_whatsapp": false,
  "theme": "light",
  "task_list_background_image_url": null,
  "skip_time_adjust_on_task_assignment_deliver": false,
  "time_tracking_mode": "manual",
  "preferences": {
    "theme": "light",
    "task_list_background_image_url": null,
    "skip_time_adjust_on_task_assignment_deliver": false,
    "skip_move_task_to_next_board_stage_suggestion": false
  }
}

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

Name	Description	type
off_days[day]	Date the off day occurs on	date
off_days[description]	Name/description of off day	string

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

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

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

Name	Description	type
team[name] required	Name of the team	string
team[master_user_id]	[Deprecated] Use leader_id	string
team[cost_center]	Cost center	string

Name	Description	type
team[name]	Name of the team	string
team[master_user_id]	[Deprecated] Use leader_id	string
team[cost_center]	Cost center	string

Name	Description	type
user_id required	New team member id	string
team_partnership	Flag to make the new team member and other members, partners	boolean

Name	Description	type
id required	ID of workflow element	integer
workflow_id required	ID of workflow	integer