Runrun.it API Documentation

How to authenticate to use the API

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

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

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

How to access your API authentication keys

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

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

Data format

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

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

Request limit

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

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

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

Pagination

Overview

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

Headers

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

Query Parameters

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

Practical Usage

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

Notes

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

Examples

First Request

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

Response Headers

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

Requesting the next page

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

Webhooks

Manage Webhooks

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

Webhook section

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

Supported events

  • task:create → Triggered when a task is created.
  • task: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

200

Headers

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

Body

[
  {
    "id": 4,
    "name": "Board Stage 767",
    "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 509",
    "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 509",
    "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 509",
    "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

200

Headers

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

Body

{
  "id": 4,
  "name": "Board Stage 768",
  "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 769",
    "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 769","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

201

Headers

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

Body

{
  "id": 4,
  "name": "Board Stage 769",
  "description": "Stage description",
  "stage_group": "opened",
  "board_id": 1,
  "position": 3,
  "last_editor_name": "Coyote 511",
  "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

200

Headers

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

Body

{
  "id": 4,
  "name": "New Board",
  "description": "New description",
  "stage_group": "opened",
  "board_id": 1,
  "position": null,
  "last_editor_name": "Coyote 512",
  "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 6",
      "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

Request

Route

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

Headers

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

cURL

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

Response

Simulated Response

Status

204

Headers

POST

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

Move a board stage to another group position

Parameters

Name Description type
position required

Board stage position in group

integer

Request

Route

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

Headers

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

Body

{
  "position": 2
}

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": 4,
  "name": "Board Stage 772",
  "description": null,
  "stage_group": "opened",
  "board_id": 1,
  "position": 2,
  "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/:id/update_use_latency_time

Update to use (or not) latency time

Parameters

Name Description type
use_latency_time required

Returns 'true' if board stage latency time is being calculated

boolean

Request

Route

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

Headers

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

Body

{
  "use_latency_time": false
}

cURL

curl "https://runrun.it/api/v1.0/boards/1/stages/1/update_use_latency_time" -d '{"use_latency_time":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

200

Headers

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

Body

{
  "id": 1,
  "name": "Stage Opened 1",
  "description": null,
  "stage_group": "opened",
  "board_id": 1,
  "position": 1,
  "last_editor_name": "Coyote 92",
  "is_following": false,
  "use_latency_time": false,
  "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/:id/update_use_scrum_points

Update to use (or not) scrum points

Parameters

Name Description type
use_scrum_points required

Returns 'true' if task points should be shown

boolean

Request

Route

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

Headers

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

Body

{
  "use_scrum_points": false
}

cURL

curl "https://runrun.it/api/v1.0/boards/1/stages/1/update_use_scrum_points" -d '{"use_scrum_points":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

200

Headers

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

Body

{
  "id": 1,
  "name": "Stage Opened 1",
  "description": null,
  "stage_group": "opened",
  "board_id": 1,
  "position": 1,
  "last_editor_name": "Coyote 93",
  "is_following": false,
  "use_latency_time": true,
  "use_scrum_points": false,
  "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": [

  ]
}

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

200

Headers

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

Body

[
  {
    "id": 1,
    "description": "Paper clips",
    "position": 1,
    "checked": false,
    "checker_id": "coyote-503",
    "checked_at": null,
    "checklist_id": 1
  },
  {
    "id": 2,
    "description": "Cups",
    "position": 2,
    "checked": false,
    "checker_id": "coyote-501",
    "checked_at": "2025-06-18T13:30:56-03:00",
    "checklist_id": 1
  }
]
GET

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

Show a checklist item

Request

Route

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

Headers

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

cURL

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

200

Headers

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

Body

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

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

Create a checklist item

Parameters

Name Description type
checklist_item[description] required

Item description

string
checklist_item[checked]

Checklist item was completed?

boolean
checklist_item[position]

Item position

integer

Request

Route

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

Headers

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

Body

{
  "checklist_item": {
    "checked": true,
    "description": "Buy more pencils",
    "position": 1
  }
}

cURL

curl "https://runrun.it/api/v1.0/checklists/1/items" -d '{"checklist_item":{"checked":true,"description":"Buy more pencils","position":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

201

Headers

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

Body

{
  "id": 2,
  "description": "Buy more pencils",
  "position": 1,
  "checked": true,
  "checker_id": "coyote-507",
  "checked_at": "2025-06-18T13:31:00-03:00",
  "checklist_id": 1
}
PUT

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

Update a checklist item

Parameters

Name Description type
checklist_item[description]

Item description

string
checklist_item[checked]

Checklist item was completed?

boolean
checklist_item[position]

Item position

integer

Request

Route

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

Headers

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

Body

{
  "checklist_item": {
    "checked": true,
    "description": "Buy beer",
    "position": 1
  }
}

cURL

curl "https://runrun.it/api/v1.0/checklists/1/items/1" -d '{"checklist_item":{"checked":true,"description":"Buy beer","position":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

200

Headers

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

Body

{
  "id": 1,
  "description": "Buy beer",
  "position": 1,
  "checked": true,
  "checker_id": "coyote-509",
  "checked_at": "2025-06-18T13:31:02-03:00",
  "checklist_id": 1
}
DELETE

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

Destroy a checklist item

Request

Route

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

Headers

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

cURL

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

Response

Simulated Response

Status

204

Headers

Checklists

GET

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

Show a checklist from a task

Request

Route

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

Headers

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

cURL

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

Status

200

Headers

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

Body

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

  ]
}
POST

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

Create a checklist from a task

Parameters

Name Description type
checklist[title] required

Checklist title

string

Request

Route

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

Headers

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

Body

{
  "checklist": {
    "title": "Office Supplies"
  }
}

cURL

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

Response

Simulated Response

Status

201

Headers

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

Body

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

  ]
}
PUT

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

Update a checklist from a task

Parameters

Name Description type
checklist[title]

Checklist title

string

Request

Route

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

Headers

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

Body

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

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

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

  ]
}
DELETE

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

Destroy a checklist from a task

Request

Route

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

Headers

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

cURL

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

Response

Simulated Response

Status

204

Headers

GET

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

Show a checklist from a task template

Request

Route

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

Headers

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

cURL

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

Status

200

Headers

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

Body

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

  ]
}
POST

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

Create a checklist from a task template

Parameters

Name Description type
checklist[title] required

Checklist title

string

Request

Route

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

Headers

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

Body

{
  "checklist": {
    "title": "Office Supplies"
  }
}

cURL

curl "https://runrun.it/api/v1.0/task_templates/3/checklist" -d '{"checklist":{"title":"Office Supplies"}}' -X POST \
	-H "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

201

Headers

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

Body

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

  ]
}
PUT

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

Update a checklist from a task template

Parameters

Name Description type
checklist[title]

Checklist title

string

Request

Route

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

Headers

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

Body

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

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": 1,
  "title": "Kitchen supplies",
  "creator_id": "coyote-834",
  "task_template_id": 4,
  "checklist_item_ids": [

  ]
}
DELETE

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

Destroy a checklist from a task template

Request

Route

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

Headers

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

cURL

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

Response

Simulated Response

Status

204

Headers

Clients

GET

/api/v1.0/clients

List 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

200

Headers

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

Body

[
  {
    "id": 1,
    "name": "Test client 416",
    "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": "2025-06-18T13:29:37-03:00",
        "updated_at": "2025-06-18T13:29:37-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

200

Headers

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

Body

{
  "id": 1,
  "name": "Test client 417",
  "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": "2025-06-18T13:29:38-03:00",
      "updated_at": "2025-06-18T13:29:38-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

201

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": "2025-06-18T13:29:40-03:00",
      "updated_at": "2025-06-18T13:29:40-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

200

Headers

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

Body

{
  "id": 1,
  "name": "Widgets Inc",
  "custom_field": null,
  "is_visible": true,
  "budgeted_hours_month": 0,
  "budgeted_cost_month": 0.0,
  "projects_count": 0,
  "time_worked": 0,
  "time_pending_not_assigned": 0,
  "time_pending_queued": 0,
  "time_pending": 0,
  "time_total": 0,
  "time_progress": 0.0,
  "cost_worked": 0.0,
  "cost_pending": 0.0,
  "cost_total": 0.0,
  "activities_6_days_ago": 0,
  "activities_5_days_ago": 0,
  "activities_4_days_ago": 0,
  "activities_3_days_ago": 0,
  "activities_2_days_ago": 0,
  "activities_1_days_ago": 0,
  "activities_0_days_ago": 0,
  "activities": 0,
  "time_pending_backlog": 0,
  "project_groups": [
    {
      "id": 1,
      "name": null,
      "client_id": 1,
      "is_default": true,
      "created_at": "2025-06-18T13:29:41-03:00",
      "updated_at": "2025-06-18T13:29:41-03:00"
    }
  ],
  "project_ids": [

  ]
}
GET

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

List all budgets

Parameters

Name Description type
client_id

Client id

integer
month

Year-Month

string
time

Include others

integer
cost

Cost

string

Request

Route

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

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

Response

Simulated Response

Status

200

Headers

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

Body

[
  {
    "client_id": 1,
    "month": "2020-07",
    "time": 10,
    "cost": "140.0"
  },
  {
    "client_id": 1,
    "month": "2025-06",
    "time": 0,
    "cost": "0.0"
  }
]
POST

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

when a budget not exists, creates a new budget

Request

Route

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

Headers

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

Body

{
  "client_monthly_budget": {
    "month": "2020-01",
    "time": 10,
    "cost": 140.0
  }
}

cURL

curl "https://runrun.it/api/v1.0/clients/1/update_monthly_budget" -d '{"client_monthly_budget":{"month":"2020-01","time":10,"cost":140.0}}' -X POST \
	-H "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

200

Headers

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

Body

{
  "client_id": 1,
  "month": "2020-01",
  "time": 10,
  "cost": "140.0"
}

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

200

Headers

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

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": "2025-06-18T13:25:20-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,
    "related_task_ids": null
  },
  {
    "id": 1,
    "user_id": "coyote-239",
    "guest_id": null,
    "is_system_message": false,
    "text": "Comment text",
    "commenter_name": "Coyote 239",
    "children_count": 0,
    "commentable_id": 1,
    "commentable_type": "Task",
    "created_at": "2025-06-18T13:25:20-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,
    "related_task_ids": null
  }
]
GET

/api/v1.0/comments/:id

Show a specific comment

Request

Route

GET /api/v1.0/comments/1

Headers

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

cURL

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

200

Headers

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

Body

{
  "id": 1,
  "user_id": "coyote-244",
  "guest_id": null,
  "is_system_message": false,
  "text": "Comment text",
  "commenter_name": "Coyote 244",
  "children_count": 0,
  "commentable_id": 1,
  "commentable_type": "Task",
  "created_at": "2025-06-18T13:25:28-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,
  "related_task_ids": null
}
POST

/api/v1.0/comments

Create a new comment

Request

Route

POST /api/v1.0/comments

Headers

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

Body

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

cURL

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

Response

Simulated Response

Status

201

Headers

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

Body

{
  "id": 1,
  "user_id": "coyote-246",
  "guest_id": null,
  "is_system_message": false,
  "text": "Comment text",
  "commenter_name": "Coyote 246",
  "children_count": 0,
  "commentable_id": 1,
  "commentable_type": "Task",
  "created_at": "2025-06-18T13:25:30-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,
  "related_task_ids": null
}
POST

/api/v1.0/comments

Create a new comment

Request

Route

POST /api/v1.0/comments

Headers

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

Body

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

cURL

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

Response

Simulated Response

Status

201

Headers

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

Body

{
  "id": 1,
  "user_id": "coyote-246",
  "guest_id": null,
  "is_system_message": false,
  "text": "Comment text",
  "commenter_name": "Coyote 246",
  "children_count": 0,
  "commentable_id": 1,
  "commentable_type": "Task",
  "created_at": "2025-06-18T13:25:30-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,
  "related_task_ids": null
}
POST

/api/v1.0/comments

Create a new project comment

Request

Route

POST /api/v1.0/comments

Headers

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

Body

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

cURL

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

Response

Simulated Response

Status

201

Headers

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

Body

{
  "id": 1,
  "user_id": "coyote-249",
  "guest_id": null,
  "is_system_message": false,
  "text": "comment",
  "commenter_name": "Coyote 249",
  "children_count": 0,
  "commentable_id": null,
  "commentable_type": "Project",
  "created_at": "2025-06-18T13:25:35-03:00",
  "edited_at": null,
  "deleted_at": null,
  "thread_id": 1,
  "quoted_comment_id": null,
  "quoted_comment_text": null,
  "quoted_comment_user_id": null,
  "quoted_comment_user_name": null,
  "quoted_comment_guest_id": null,
  "quoted_comment_guest_name": null,
  "task_id": null,
  "comment_id": null,
  "team_id": null,
  "enterprise_id": null,
  "document_id": null,
  "is_legacy": false,
  "media": null,
  "documents": [

  ],
  "reactions": [

  ],
  "is_automation_message": false,
  "related_task_ids": null
}
PUT

/api/v1.0/comments/:id

Update a comment

Request

Route

PUT /api/v1.0/comments/1

Headers

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

Body

{
  "text": "New text"
}

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": 1,
  "user_id": "coyote-250",
  "guest_id": null,
  "is_system_message": false,
  "text": "New text",
  "commenter_name": "Coyote 250",
  "children_count": 0,
  "commentable_id": 1,
  "commentable_type": "Task",
  "created_at": "2025-06-18T13:25:36-03:00",
  "edited_at": "2025-06-18T13:25:36-03:00",
  "deleted_at": null,
  "thread_id": 1,
  "quoted_comment_id": null,
  "quoted_comment_text": null,
  "quoted_comment_user_id": null,
  "quoted_comment_user_name": null,
  "quoted_comment_guest_id": null,
  "quoted_comment_guest_name": null,
  "task_id": 1,
  "comment_id": null,
  "team_id": null,
  "enterprise_id": null,
  "document_id": null,
  "is_legacy": false,
  "media": null,
  "documents": [

  ],
  "reactions": [

  ],
  "is_automation_message": false,
  "related_task_ids": null
}
DELETE

/api/v1.0/comments/:id

Destroy a comment

Request

Route

DELETE /api/v1.0/comments/1

Headers

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

cURL

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

Response

Simulated Response

Status

204

Headers

POST

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

Reaction to a comment

Request

Route

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

Headers

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

Body

{
  "emoji": "👨"
}

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": 1,
  "user_id": "coyote-254",
  "guest_id": null,
  "is_system_message": false,
  "text": "Comment text",
  "commenter_name": "Coyote 254",
  "children_count": 0,
  "commentable_id": 1,
  "commentable_type": "Task",
  "created_at": "2025-06-18T13:25:43-03:00",
  "edited_at": null,
  "deleted_at": null,
  "thread_id": 1,
  "quoted_comment_id": null,
  "quoted_comment_text": null,
  "quoted_comment_user_id": null,
  "quoted_comment_user_name": null,
  "quoted_comment_guest_id": null,
  "quoted_comment_guest_name": null,
  "task_id": 1,
  "comment_id": null,
  "team_id": null,
  "enterprise_id": null,
  "document_id": null,
  "is_legacy": false,
  "media": null,
  "documents": [

  ],
  "reactions": [
    {
      "emoji": "👨",
      "count": 1,
      "users": [
        {
          "slug": "coyote-254",
          "name": "Coyote 254"
        }
      ]
    }
  ],
  "is_automation_message": false,
  "related_task_ids": null
}

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

200

Headers

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

Body

[
  {
    "id": "coyote-555",
    "name": "Coyote 555",
    "email": "coyote590@acme.foo",
    "avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-651/coyote-555/mini.png",
    "avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-651/coyote-555/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": "2025-06-18T13:32:03-03:00",
    "in_company_since": null,
    "is_certified": false,
    "is_certified_expert": false,
    "language": "en-US",
    "alt_id": "f52bf42116b911363f6ccea0cf913668",
    "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-554",
    "name": "Coyote 554",
    "email": "coyote589@acme.foo",
    "avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-651/coyote-554/mini.png",
    "avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-651/coyote-554/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": "2025-06-18T13:32:03-03:00",
    "in_company_since": null,
    "is_certified": false,
    "is_certified_expert": false,
    "language": "en-US",
    "alt_id": "34395f29661dd7372d8b7da60ccc89bd",
    "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

Adds the user represented by demander_id as demander of the user_id

Parameters

Name Description type
user_id required

User's ID

string

Request

Route

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

Headers

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

Body

{
  "demander_id": "coyote-559"
}

cURL

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

Response

Simulated Response

Status

201

Headers

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

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

Replace a user partners list

Parameters

Name Description type
user_id required

User's ID

string

Request

Route

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

Headers

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

Body

{
  "ids": "coyote-563,coyote-564"
}

cURL

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

Response

Simulated Response

Status

200

Headers

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

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

Destroy a demander of a user

Parameters

Name Description type
user_id required

User's ID

string

Request

Route

DELETE /api/v1.0/users/coyote-566/demanders/coyote-567

Headers

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

cURL

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

Response

Simulated Response

Status

204

Headers

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

200

Headers

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

Body

[
  {
    "id": 1,
    "title": "Bla 322",
    "is_working_on": false,
    "user_id": "coyote-559",
    "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": "2025-06-18T13:32: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 277",
    "client_id": 1,
    "project_name": "Test project 260",
    "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 420",
    "user_name": "Coyote 559",
    "guest_name": null,
    "board_name": "Board 332",
    "board_stage_name": "Board Stage 967",
    "board_stage_description": null,
    "team_name": null,
    "type_color": "FFFFFF",
    "state": "queued",
    "overdue": null,
    "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": "2025-06-18T13:32:09-03:00",
    "automation_id": null,
    "automation_name": null,
    "priority": 1,
    "tag_list": "",
    "tags": [

    ],
    "scheduled_start_time": null,
    "is_scheduled": false,
    "current_evaluator_id": null,
    "uid": 1,
    "responsible_id": "coyote-558",
    "task_state_id": 1,
    "responsible_name": "Coyote 558",
    "task_state_name": "Board Stage 967",
    "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 967",
    "assignments": [
      {
        "id": "49537adb9",
        "task_id": 1,
        "assignee_id": "coyote-558",
        "team_id": null,
        "assignee_name": "Coyote 558",
        "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": "2025-06-18T13:32:09-03:00",
        "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-344/coyote-558/mini.png",
        "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-344/coyote-558/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

201

Headers

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

Body

{
  "id": 2,
  "title": "Bla 325",
  "is_working_on": false,
  "user_id": "coyote-563",
  "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": "2025-06-18T13:32:12-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 280",
  "client_id": 2,
  "project_name": "Test project 263",
  "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 423",
  "user_name": "Coyote 563",
  "guest_name": null,
  "board_name": "Board 335",
  "board_stage_name": "Board Stage 976",
  "board_stage_description": null,
  "team_name": null,
  "type_color": "FFFFFF",
  "state": "queued",
  "overdue": null,
  "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": "2025-06-18T13:32:12-03:00",
  "automation_id": null,
  "automation_name": null,
  "priority": 2,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 2,
  "responsible_id": "coyote-561",
  "task_state_id": 4,
  "responsible_name": "Coyote 561",
  "task_state_name": "Board Stage 976",
  "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 976",
  "assignments": [
    {
      "id": "92a6f5b72",
      "task_id": 2,
      "assignee_id": "coyote-561",
      "team_id": null,
      "assignee_name": "Coyote 561",
      "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": "2025-06-18T13:32:12-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-345/coyote-561/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-345/coyote-561/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

Parameters

Name Description type
task_id required

ID of the task

integer

Request

Route

DELETE /api/v1.0/tasks/2/descendants/1

Headers

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

cURL

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

Response

Simulated Response

Status

204

Headers

Description

GET

/api/v1.0/descriptions

Query Multiple Descriptions

Parameters

Name Description
task_template_ids

IDs of Task Templates if belongs
project_ids

IDs of Projects if belongs

Request

Route

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

Headers

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

Query Parameters

project_ids=1,2

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

[
  {
    "project_id": 1,
    "description": "Cool Project",
    "current_editor_id": null,
    "current_editor_name": null,
    "edited_at": "2025-06-18T13:29:48-03:00",
    "locked_at": null
  },
  {
    "project_id": 2,
    "description": "Expensive Project",
    "current_editor_id": null,
    "current_editor_name": null,
    "edited_at": "2025-06-18T13:29:48-03:00",
    "locked_at": null
  }
]
GET

/api/v1.0/descriptions

Query Single Project Description

Parameters

Name Description
task_draft_id

Task draft
task_template_id

Task template
project_id

Project

Request

Route

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

Headers

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

Query Parameters

project_id=1

cURL

curl -g "https://runrun.it/api/v1.0/descriptions?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

200

Headers

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

Body

{
  "project_id": 1,
  "description": "Cool Project",
  "current_editor_id": null,
  "current_editor_name": null,
  "edited_at": "2025-06-18T13:29:54-03:00",
  "locked_at": null
}
GET

/api/v1.0/descriptions

Query Single Task Template Description

Parameters

Name Description
task_draft_id

Task draft
task_template_id

Task template
project_id

Project

Request

Route

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

Headers

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

Query Parameters

task_template_id=3

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "task_template_id": 3,
  "description": "Awesome Task",
  "current_editor_id": null,
  "current_editor_name": null,
  "edited_at": "2025-06-18T13:29:55-03:00",
  "locked_at": null
}
PUT

/api/v1.0/descriptions

Update Project Description

Parameters

Name Description type
description[description] required

The text of the description

text

Request

Route

PUT /api/v1.0/descriptions

Headers

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

Body

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

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "project_id": 1,
  "description": "Another Awesome Project Description",
  "current_editor_id": null,
  "current_editor_name": null,
  "edited_at": "2025-06-18T13:29:59-03:00",
  "locked_at": null
}
PUT

/api/v1.0/descriptions

Update Task Template Description

Parameters

Name Description type
description[description] required

The text of the description

text

Request

Route

PUT /api/v1.0/descriptions

Headers

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

Body

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

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "task_template_id": 4,
  "description": "Another Awesome Project Description",
  "current_editor_id": null,
  "current_editor_name": null,
  "edited_at": "2025-06-18T13:30:00-03:00",
  "locked_at": null
}

Documents

GET

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

List all documents uploaded to a task

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

Request

Route

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

Headers

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

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

[
  {
    "id": 1,
    "type": "UploadedDocument",
    "data_file_name": "awesome_report_1.txt",
    "data_file_size": 10,
    "data_content_type": "text/plain",
    "file_name": "awesome_report_1.txt",
    "file_size": 10,
    "file_content_type": "text/plain",
    "file_extension": "txt",
    "uploaded_at": "2025-06-18T13:24:37-03:00",
    "transfered": true,
    "uploader_id": "coyote-53",
    "uploader_name": "Coyote 53",
    "attachable_id": 1,
    "attachable_type": "Task",
    "attachable_name": "Bla 225",
    "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

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

200

Headers

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

Body

{
  "id": 1,
  "type": "UploadedDocument",
  "data_file_name": "awesome_report_4.txt",
  "data_file_size": 10,
  "data_content_type": "text/plain",
  "file_name": "awesome_report_4.txt",
  "file_size": 10,
  "file_content_type": "text/plain",
  "file_extension": "txt",
  "uploaded_at": "2025-06-18T13:24:43-03:00",
  "transfered": true,
  "uploader_id": "coyote-62",
  "uploader_name": "Coyote 62",
  "attachable_id": 1,
  "attachable_type": "Task",
  "attachable_name": "Bla 228",
  "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

201

Headers

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

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-70",
  "uploader_name": "Coyote 70",
  "attachable_id": 1,
  "attachable_type": "Task",
  "attachable_name": "Bla 232",
  "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": "eyJleHBpcmF0aW9uIjoiMjAyNS0wNi0xOFQxNzoyNDo0OVoiLCJjb25kaXRpb25zIjpbWyJzdGFydHMtd2l0aCIsIiRrZXkiLCIiXSxbInN0YXJ0cy13aXRoIiwiJEZpbGVuYW1lIiwiIl0sWyJzdGFydHMtd2l0aCIsIiRuYW1lIiwiIl0seyJzdWNjZXNzX2FjdGlvbl9zdGF0dXMiOiIyMDEifSxbImNvbnRlbnQtbGVuZ3RoLXJhbmdlIiwwLDUzNjg3MDkxMjBdLHsiYnVja2V0IjoicnVucnVuaXRfZGV2In0seyJhY2wiOiJwcml2YXRlIn0seyJrZXkiOiJkYXRhLzEvZXhhbXBsZS50eHQifSx7ImNvbnRlbnRfdHlwZSI6InRleHQvcGxhaW4ifV19",
    "signature": "z6JKwDoLSDw8NPbDnIRXzshuDik=",
    "AWSAccessKeyId": "ABCDEFGHIJKLMNOPQRST",
    "content_type": "text/plain",
    "filename": "example.txt"
  }
}
DELETE

/api/v1.0/documents/:id

Destroy a document

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

Request

Route

DELETE /api/v1.0/documents/1

Headers

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

cURL

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

Response

Simulated Response

Status

204

Headers

GET

/api/v1.0/documents/download_zip

Download multiple documents as zip

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

Parameters

Name Description
ids

List of document's ids to download

Enterprises

GET

/api/v1.0/enterprises/:id

Show details for requesting user's enterprise

Request

Route

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

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-333" -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 boolean
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

200

Headers

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

Body

{
  "id": "acme-333",
  "name": "Acme 333",
  "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": "e2aa2147057f3e75aa3751b8457f8964",
  "oid": "49537adb9",
  "support_phone": "+55 11 2769-9713",
  "trial_days_left": 30,
  "disabled_reason": null,
  "disabled_at": null,
  "currency_symbol": "USD",
  "created_at": "2025-06-05T12:14:31-03:00",
  "master_user_id": "coyote-431",
  "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": "2025-07-05",
  "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-586

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-586" -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

200

Headers

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

Body

{
  "id": "acme-586",
  "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": "725055660559e8a31fef1bc8c130e275",
  "oid": "49537adb9",
  "support_phone": "+55 11 2769-9713",
  "trial_days_left": 30,
  "disabled_reason": null,
  "disabled_at": null,
  "currency_symbol": "USD",
  "created_at": "2025-06-18T13:31:25-03:00",
  "master_user_id": "coyote-518",
  "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": "2025-07-18",
  "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.

"Show the all the estimatives for a task."

Request

Route

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

Headers

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

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

[
  {
    "id": 3,
    "task_id": 1,
    "work_seconds": 3600,
    "created_at": "2025-06-18T13:31:10-03:00",
    "is_standard": false
  },
  {
    "id": 4,
    "task_id": 1,
    "work_seconds": 7200,
    "created_at": "2025-06-18T13:31:10-03:00",
    "is_standard": false
  }
]
POST

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

Create a estimative for a task.

"Create a estimate for a task."

Request

Route

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

Headers

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

Body

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

cURL

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

Response

Simulated Response

Status

201

Headers

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

Body

{
  "id": 4,
  "task_id": 1,
  "work_seconds": 9000,
  "created_at": "2025-06-18T13:31:11-03:00",
  "is_standard": false
}

EventNotification

GET

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

List all user's event notifications

Request

Route

GET /api/v1.0/users/1/event_notifications

Headers

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

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

[
  {
    "id": 1,
    "event": "event_notification:create",
    "title": "this is a title",
    "message": "this is a message",
    "full_message_formatted": null,
    "readed_in": null,
    "group_key": null,
    "happened_at": "2025-06-05T12:14:40-03:00",
    "extra": {
    }
  }
]
POST

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

Assign readed_in on event_notification

Request

Route

POST /api/v1.0/users/1/event_notifications/1/mark_as_read

Headers

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

cURL

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

200

Headers

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

Body

{
  "id": 1,
  "event": "event_notification:create",
  "title": "this is a title",
  "message": "this is a message",
  "full_message_formatted": null,
  "readed_in": "2025-06-18T13:34:57-03:00",
  "group_key": null,
  "happened_at": "2025-06-18T13:34:57-03:00",
  "extra": {
  }
}
POST

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

Assigns all user's event notifications

Request

Route

POST /api/v1.0/users/1/event_notifications/mark_all_as_read

Headers

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

cURL

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

200

Headers

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

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

Delete a event_notification

Request

Route

DELETE /api/v1.0/users/1/event_notifications/1

Headers

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

cURL

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

Response

Simulated Response

Status

204

Headers

POST

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

Delete all event_notifications

Request

Route

POST /api/v1.0/users/1/event_notifications/destroy_all

Headers

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

cURL

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

204

Headers

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

200

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

Request

Route

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

Headers

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

cURL

curl -g "https://runrun.it/api/v1.0/projects/filters/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

200

Headers

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

Body

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

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

Destroy a project filter

Destroy a filter record.

Request

Route

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

Headers

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

cURL

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

Response

Simulated Response

Status

204

Headers

GET

/api/v1.0/tasks/filters

List all tasks filters

List all tasks filters that the current user can view.

Request

Route

GET /api/v1.0/tasks/filters

Headers

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

cURL

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

200

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

Request

Route

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

Headers

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

cURL

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

200

Headers

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

Body

{
  "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
}
DELETE

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

Destroy a task filter

Destroy a filter record.

Request

Route

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

Headers

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

cURL

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

Response

Simulated Response

Status

204

Headers

Justifications

POST

/api/v1.0/justifications

Create an arbitrary Justification

Request

Route

POST /api/v1.0/justifications

Headers

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

Body

{
  "text": "New Justification 1",
  "date": "2025-06-17"
}

cURL

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

Response

Simulated Response

Status

201

Headers

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

Body

{
  "id": 1,
  "user_id": "coyote-603",
  "date": "2025-06-17",
  "text": "New Justification 1",
  "task_id": null,
  "task_title": null
}
POST

/api/v1.0/justifications

Create an arbitrary Justification for a task

Request

Route

POST /api/v1.0/justifications

Headers

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

Body

{
  "text": "New Justification 2",
  "date": "2025-06-17",
  "task_id": 171
}

cURL

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

Response

Simulated Response

Status

201

Headers

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

Body

{
  "id": 1,
  "user_id": "coyote-604",
  "date": "2025-06-17",
  "text": "New Justification 2",
  "task_id": null,
  "task_title": null
}
PUT

/api/v1.0/justifications/:justification_id

Update the text of a justification

Parameters

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

Request

Route

PUT /api/v1.0/justifications/1

Headers

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

Body

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

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": 1,
  "user_id": "coyote-606",
  "date": "2025-06-16",
  "text": "Old justification with a new text",
  "task_id": null,
  "task_title": null
}

Manual Work Periods

GET

/api/v1.0/manual_work_periods

List all manual work periods

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

Parameters

Name Description type
manual_work_period[task_id]

ID of related task

integer
manual_work_period[from]

Manual work period from

date_time
manual_work_period[before]

Manual work period before

date_time

Request

Route

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

Headers

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

Query Parameters

task_id=1

cURL

curl -g "https://runrun.it/api/v1.0/manual_work_periods?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

200

Headers

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

Body

[
  {
    "id": 1,
    "task_id": 1,
    "seconds": 1000,
    "date_to_apply": "2019-02-08",
    "worker_name": "Coyote 560",
    "user_id": "coyote-560",
    "team_id": null,
    "team_name": null,
    "board_stage_id": null,
    "board_stage_name": null,
    "task_state_id": null,
    "task_status_id": null
  }
]
GET

/api/v1.0/manual_work_periods/:id

Show a Manual Work Period

Request

Route

GET /api/v1.0/manual_work_periods/1

Headers

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

cURL

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

200

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 561",
  "user_id": "coyote-561",
  "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

201

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 562",
  "user_id": "coyote-562",
  "team_id": null,
  "team_name": null,
  "board_stage_id": null,
  "board_stage_name": null,
  "task_state_id": null,
  "task_status_id": null
}
PUT

/api/v1.0/manual_work_periods/:id

Update a Manual Work Period

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

Parameters

Name Description type
manual_work_period[seconds]

Time added in seconds

integer

Request

Route

PUT /api/v1.0/manual_work_periods/1

Headers

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

Body

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

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": 1,
  "task_id": 1,
  "seconds": 2000,
  "date_to_apply": "2019-02-08",
  "worker_name": "Coyote 563",
  "user_id": "coyote-563",
  "team_id": null,
  "team_name": null,
  "board_stage_id": null,
  "board_stage_name": null,
  "task_state_id": null,
  "task_status_id": null
}
DELETE

/api/v1.0/manual_work_periods/:id

Destroy a Manual Work Period

Request

Route

DELETE /api/v1.0/manual_work_periods/1

Headers

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

cURL

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

Response

Simulated Response

Status

204

Headers

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

200

Headers

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

Body

[
  {
    "id": 2,
    "day": "2025-06-20",
    "description": "Ice Cream Day"
  },
  {
    "id": 1,
    "day": "2025-06-19",
    "description": "Developer Day"
  }
]
GET

/api/v1.0/off_days/:id

Show an off day

Request

Route

GET /api/v1.0/off_days/1

Headers

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

cURL

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

Status

200

Headers

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

Body

{
  "id": 1,
  "day": "2025-06-21",
  "description": "City holiday 9"
}
POST

/api/v1.0/off_days

Create an off day

Parameters

Name Description type
off_day[day] required

Date the off day occurs on

date
off_day[description]

Name/description of off day

string

Request

Route

POST /api/v1.0/off_days

Headers

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

Body

{
  "off_day": {
    "day": "2020-12-25",
    "description": "Christmas"
  }
}

cURL

curl "https://runrun.it/api/v1.0/off_days" -d '{"off_day":{"day":"2020-12-25","description":"Christmas"}}' -X POST \
	-H "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

201

Headers

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

Body

{
  "id": 1,
  "day": "2020-12-25",
  "description": "Christmas"
}
PUT

/api/v1.0/off_days/:id

Update an off day

Parameters

Name Description type
off_days[day]

Date the off day occurs on

date
off_days[description]

Name/description of off day

string

Request

Route

PUT /api/v1.0/off_days/1

Headers

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

Body

{
  "off_day": {
    "day": "2020-12-11",
    "description": "Developer Day"
  }
}

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": 1,
  "day": "2020-12-11",
  "description": "Developer Day"
}
DELETE

/api/v1.0/off_days/:id

Destroy an off day

Request

Route

DELETE /api/v1.0/off_days/1

Headers

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

cURL

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

Response

Simulated Response

Status

204

Headers

Partners

GET

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

List all partners of user

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

Parameters

Name Description type
user_id required

User's ID

string

Request

Route

GET /api/v1.0/users/coyote-423/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-423/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

200

Headers

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

Body

[
  {
    "id": "coyote-424",
    "name": "Coyote 424",
    "email": "coyote469@acme.foo",
    "avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-211/coyote-424/mini.png",
    "avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-211/coyote-424/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": "2025-06-18T13:29:55-03:00",
    "in_company_since": null,
    "is_certified": false,
    "is_certified_expert": false,
    "language": "en-US",
    "alt_id": "71bcbb7a2a531585ebe90c3e1ad4dfca",
    "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-423",
    "name": "Coyote 423",
    "email": "coyote468@acme.foo",
    "avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-211/coyote-423/mini.png",
    "avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-211/coyote-423/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": "2025-06-18T13:29:55-03:00",
    "in_company_since": null,
    "is_certified": false,
    "is_certified_expert": false,
    "language": "en-US",
    "alt_id": "d8c11ab1144e1e165570135aaf1277a2",
    "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

Adds the user represented by partner_id as partner of the user_id

Parameters

Name Description type
user_id required

User's ID

string

Request

Route

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

Headers

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

Body

{
  "partner_id": "coyote-433"
}

cURL

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

Response

Simulated Response

Status

201

Headers

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

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

Replace a user partners list

Parameters

Name Description type
user_id required

User's ID

string

Request

Route

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

Headers

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

Body

{
  "ids": "coyote-437,coyote-438"
}

cURL

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

Response

Simulated Response

Status

200

Headers

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

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

Destroy a partner of a user

Parameters

Name Description type
user_id required

User's ID

string

Request

Route

DELETE /api/v1.0/users/coyote-440/partners/coyote-441

Headers

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

cURL

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

Response

Simulated Response

Status

204

Headers

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

200

Headers

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

Body

[
  {
    "id": 2,
    "title": "Bla 298",
    "is_working_on": false,
    "user_id": "coyote-406",
    "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": "2025-06-18T13:29: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 241",
    "client_id": 2,
    "project_name": "Test project 224",
    "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 381",
    "user_name": "Coyote 406",
    "guest_name": null,
    "board_name": "Board 288",
    "board_stage_name": "Board Stage 835",
    "board_stage_description": null,
    "team_name": null,
    "type_color": "FFFFFF",
    "state": "queued",
    "overdue": null,
    "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": "2025-06-18T13:29:44-03:00",
    "automation_id": null,
    "automation_name": null,
    "priority": 2,
    "tag_list": "",
    "tags": [

    ],
    "scheduled_start_time": null,
    "is_scheduled": false,
    "current_evaluator_id": null,
    "uid": 2,
    "responsible_id": "coyote-404",
    "task_state_id": 4,
    "responsible_name": "Coyote 404",
    "task_state_name": "Board Stage 835",
    "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 835",
    "assignments": [
      {
        "id": "92a6f5b72",
        "task_id": 2,
        "assignee_id": "coyote-404",
        "team_id": null,
        "assignee_name": "Coyote 404",
        "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": "2025-06-18T13:29:44-03:00",
        "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-205/coyote-404/mini.png",
        "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-205/coyote-404/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

201

Headers

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

Body

{
  "id": 2,
  "title": "Bla 300",
  "is_working_on": false,
  "user_id": "coyote-409",
  "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": "2025-06-18T13:29:46-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 243",
  "client_id": 2,
  "project_name": "Test project 226",
  "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 383",
  "user_name": "Coyote 409",
  "guest_name": null,
  "board_name": "Board 290",
  "board_stage_name": "Board Stage 841",
  "board_stage_description": null,
  "team_name": null,
  "type_color": "FFFFFF",
  "state": "queued",
  "overdue": null,
  "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": "2025-06-18T13:29:46-03:00",
  "automation_id": null,
  "automation_name": null,
  "priority": 2,
  "tag_list": "",
  "tags": [

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

  ],
  "approved": null,
  "task_status_id": 4,
  "task_status_name": "Board Stage 841",
  "assignments": [
    {
      "id": "92a6f5b72",
      "task_id": 2,
      "assignee_id": "coyote-407",
      "team_id": null,
      "assignee_name": "Coyote 407",
      "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": "2025-06-18T13:29:46-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-206/coyote-407/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-206/coyote-407/regular.png",
      "time_worked_not_persisted": 0
    }
  ],
  "follower_ids": [

  ]
}
DELETE

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

Remove a task prerequisite from a task

Parameters

Name Description type
task_id required

ID of the task

integer
id required

ID of the task prerequisite

integer

Request

Route

DELETE /api/v1.0/tasks/1/prerequisites/2

Headers

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

cURL

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

Response

Simulated Response

Status

204

Headers

GET

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

List all task template prerequisites from a task template

Parameters

Name Description type
task_template_id required

ID of the task template

integer

Request

Route

GET /api/v1.0/task_templates/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/task_templates/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

200

Headers

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

Body

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

    ],
    "created_at": "2025-06-18T13:29:51-03:00",
    "follower_ids": [

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

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

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

Add a task template prerequisite to a task template

Parameters

Name Description type
task_template_id required

ID of the task template

integer

Request

Route

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

Headers

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

Body

{
  "prerequisite": {
    "id": 4
  }
}

cURL

curl "https://runrun.it/api/v1.0/task_templates/3/prerequisites" -d '{"prerequisite":{"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

201

Headers

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

Body

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

  ],
  "created_at": "2025-06-18T13:29:52-03:00",
  "follower_ids": [

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

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

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

Remove a task template prerequisite from a task template

Parameters

Name Description type
task_template_id required

ID of the task template

integer
id required

ID of the task template prerequisite

integer

Request

Route

DELETE /api/v1.0/task_templates/5/prerequisites/6

Headers

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

cURL

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

Response

Simulated Response

Status

204

Headers

Project Description

PUT

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

Update the project description

Parameters

Name Description type
description

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": "2025-06-18T13:31:08-03:00",
    "updated_at": "2025-06-18T13:31:08-03:00",
    "edited_at": "2025-06-18T13:31:08-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":"2025-06-18T13:31:08-03:00","updated_at":"2025-06-18T13:31:08-03:00","edited_at":"2025-06-18T13:31:08-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

200

Headers

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

Body

{
  "id": 1,
  "description": "Gorgeous!",
  "current_editor_id": null,
  "current_editor_name": null,
  "edited_at": "2025-06-18T13:31:08-03:00",
  "locked_at": null
}

Project Groups

GET

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

List all Project Groups

Request

Route

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

Headers

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

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

[
  {
    "id": 1,
    "name": "No group",
    "is_default": true,
    "client_id": 1,
    "client_name": "Test client 294",
    "projects_count": 0,
    "time_worked": 0,
    "time_pending_not_assigned": 0,
    "time_pending_queued": 0,
    "time_pending": 0,
    "time_total": 0,
    "time_progress": 0.0,
    "cost_worked": 0.0,
    "cost_pending": 0.0,
    "cost_total": 0.0,
    "activities_6_days_ago": 0,
    "activities_5_days_ago": 0,
    "activities_4_days_ago": 0,
    "activities_3_days_ago": 0,
    "activities_2_days_ago": 0,
    "activities_1_days_ago": 0,
    "activities_0_days_ago": 0,
    "activities": 0,
    "time_pending_backlog": 0,
    "project_sub_groups": [
      {
        "id": 1,
        "name": null,
        "project_group_id": 1,
        "is_default": true,
        "created_at": "2025-06-18T13:31:13-03:00",
        "updated_at": "2025-06-18T13:31:13-03:00"
      }
    ]
  }
]
GET

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

Show a Project Group

Request

Route

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

Headers

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

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": 2,
  "name": "Project Group 1",
  "is_default": false,
  "client_id": 1,
  "client_name": "Test client 295",
  "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": "2025-06-18T13:31:15-03:00",
      "updated_at": "2025-06-18T13:31:15-03:00"
    }
  ]
}
POST

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

Create a Project Group

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

Parameters

Name Description type
name

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

201

Headers

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

Body

{
  "id": 2,
  "name": "Project Group 2",
  "is_default": false,
  "client_id": 1,
  "client_name": "Test client 296",
  "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": "2025-06-18T13:31:16-03:00",
      "updated_at": "2025-06-18T13:31:16-03:00"
    }
  ]
}
PUT

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

Update a Project Group

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

Request

Route

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

Headers

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

Body

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

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": 2,
  "name": "New Name",
  "is_default": false,
  "client_id": 1,
  "client_name": "Test client 298",
  "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": "2025-06-18T13:31:18-03:00",
      "updated_at": "2025-06-18T13:31:18-03:00"
    }
  ]
}
DELETE

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

Destroy a Project Group

Request

Route

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

Headers

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

cURL

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

Response

Simulated Response

Status

204

Headers

POST

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

Move project group to another client

Request

Route

POST /api/v1.0/project_groups/2/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/project_groups/2/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

200

Headers

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

Body

{
  "id": 2,
  "name": "Project Group 6",
  "is_default": false,
  "client_id": 2,
  "client_name": "Client B",
  "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": "2025-06-18T13:31:20-03:00",
      "updated_at": "2025-06-18T13:31:20-03:00"
    }
  ]
}

Project Sub Groups

GET

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

List all Project Sub Groups using Project Group id

Request

Route

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

Headers

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

Query Parameters

sort_dir=desc
search_term=Project Sub Group 1

cURL

curl -g "https://runrun.it/api/v1.0/project_groups/2/project_sub_groups?sort_dir=desc&search_term=Project+Sub+Group+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

200

Headers

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

Body

[
  {
    "id": 3,
    "name": "Project Sub Group 1",
    "is_default": false,
    "project_group_id": 2,
    "client_name": "Test client 380",
    "client_id": 1,
    "project_group_name": "Project Group 1",
    "project_group_is_default": false,
    "projects_count": 0,
    "time_worked": 0,
    "time_pending_not_assigned": 0,
    "time_pending_queued": 0,
    "time_pending": 0,
    "time_total": 0,
    "time_progress": 0.0,
    "cost_worked": 0.0,
    "cost_pending": 0.0,
    "cost_total": 0.0,
    "activities_6_days_ago": 0,
    "activities_5_days_ago": 0,
    "activities_4_days_ago": 0,
    "activities_3_days_ago": 0,
    "activities_2_days_ago": 0,
    "activities_1_days_ago": 0,
    "activities_0_days_ago": 0,
    "activities": 0,
    "time_pending_backlog": 0
  }
]
GET

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

List all Project Sub Groups using Client id

Request

Route

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

Headers

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

Query Parameters

sort_dir=desc
search_term=Project Sub Group 2

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

[
  {
    "id": 3,
    "name": "Project Sub Group 2",
    "is_default": false,
    "project_group_id": 2,
    "client_name": "Test client 381",
    "client_id": 1,
    "project_group_name": "Project Group 2",
    "project_group_is_default": false,
    "projects_count": 0,
    "time_worked": 0,
    "time_pending_not_assigned": 0,
    "time_pending_queued": 0,
    "time_pending": 0,
    "time_total": 0,
    "time_progress": 0.0,
    "cost_worked": 0.0,
    "cost_pending": 0.0,
    "cost_total": 0.0,
    "activities_6_days_ago": 0,
    "activities_5_days_ago": 0,
    "activities_4_days_ago": 0,
    "activities_3_days_ago": 0,
    "activities_2_days_ago": 0,
    "activities_1_days_ago": 0,
    "activities_0_days_ago": 0,
    "activities": 0,
    "time_pending_backlog": 0
  }
]
GET

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

Show a Project Sub Group

Request

Route

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

Headers

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

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": 3,
  "name": "Project Sub Group 3",
  "is_default": false,
  "project_group_id": 2,
  "client_name": "Test client 382",
  "client_id": 1,
  "project_group_name": "Project Group 3",
  "project_group_is_default": false,
  "projects_count": 0,
  "time_worked": 0,
  "time_pending_not_assigned": 0,
  "time_pending_queued": 0,
  "time_pending": 0,
  "time_total": 0,
  "time_progress": 0.0,
  "cost_worked": 0.0,
  "cost_pending": 0.0,
  "cost_total": 0.0,
  "activities_6_days_ago": 0,
  "activities_5_days_ago": 0,
  "activities_4_days_ago": 0,
  "activities_3_days_ago": 0,
  "activities_2_days_ago": 0,
  "activities_1_days_ago": 0,
  "activities_0_days_ago": 0,
  "activities": 0,
  "time_pending_backlog": 0
}
POST

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

Create a Project Sub Group

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

Parameters

Name Description type
name

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

201

Headers

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

Body

{
  "id": 3,
  "name": "Project Sub Group 4",
  "is_default": false,
  "project_group_id": 2,
  "client_name": "Test client 383",
  "client_id": 1,
  "project_group_name": "Project Group 4",
  "project_group_is_default": false,
  "projects_count": 0,
  "time_worked": 0,
  "time_pending_not_assigned": 0,
  "time_pending_queued": 0,
  "time_pending": 0,
  "time_total": 0,
  "time_progress": 0.0,
  "cost_worked": 0.0,
  "cost_pending": 0.0,
  "cost_total": 0.0,
  "activities_6_days_ago": 0,
  "activities_5_days_ago": 0,
  "activities_4_days_ago": 0,
  "activities_3_days_ago": 0,
  "activities_2_days_ago": 0,
  "activities_1_days_ago": 0,
  "activities_0_days_ago": 0,
  "activities": 0,
  "time_pending_backlog": 0
}
PUT

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

Update a Project Sub Group

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

Request

Route

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

Headers

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

Body

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

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": 3,
  "name": "New Name",
  "is_default": false,
  "project_group_id": 2,
  "client_name": "Test client 386",
  "client_id": 1,
  "project_group_name": "Project Group 6",
  "project_group_is_default": false,
  "projects_count": 0,
  "time_worked": 0,
  "time_pending_not_assigned": 0,
  "time_pending_queued": 0,
  "time_pending": 0,
  "time_total": 0,
  "time_progress": 0.0,
  "cost_worked": 0.0,
  "cost_pending": 0.0,
  "cost_total": 0.0,
  "activities_6_days_ago": 0,
  "activities_5_days_ago": 0,
  "activities_4_days_ago": 0,
  "activities_3_days_ago": 0,
  "activities_2_days_ago": 0,
  "activities_1_days_ago": 0,
  "activities_0_days_ago": 0,
  "activities": 0,
  "time_pending_backlog": 0
}
DELETE

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

Destroy a Project Sub Group

Request

Route

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

Headers

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

cURL

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

Response

Simulated Response

Status

204

Headers

POST

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

Move project sub group to another project group

Request

Route

POST /api/v1.0/project_sub_groups/3/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/project_sub_groups/3/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

200

Headers

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

Body

{
  "id": 3,
  "name": "Project Sub Group 9",
  "is_default": false,
  "project_group_id": 4,
  "client_name": "Client B",
  "client_id": 2,
  "project_group_name": "Project Group B",
  "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
}

Project Templates

GET

/api/v1.0/project_templates

List all Project Templates

Request

Route

GET /api/v1.0/project_templates

Headers

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

cURL

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

200

Headers

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

Body

[

]
GET

/api/v1.0/project_templates/:id

Show a Project Template

Request

Route

GET /api/v1.0/project_templates/1

Headers

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

cURL

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

200

Headers

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

Body

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

/api/v1.0/project_templates/

Create a Project Template

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

Parameters

Name Description type
name

Name of project template

string

Request

Route

POST /api/v1.0/project_templates/

Headers

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

Body

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

cURL

curl "https://runrun.it/api/v1.0/project_templates/" -d '{"project_template":{"name":"Test project template 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

201

Headers

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

Body

{
  "id": 1,
  "name": "Test project template 2"
}
PUT

/api/v1.0/project_templates/:id

Update a Project Template

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

Request

Route

PUT /api/v1.0/project_templates/1

Headers

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

Body

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

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

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

/api/v1.0/project_templates/:id

Destroy a Project Template

Request

Route

DELETE /api/v1.0/project_templates/1

Headers

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

cURL

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

Response

Simulated Response

Status

204

Headers

ProjectExtraCost

GET

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

List all extra costs of a project

Request

Route

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

Headers

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

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

[
  {
    "id": 1,
    "description": "Cost 1",
    "date": "2025-06-18",
    "amount": 1000.0,
    "project_id": 1,
    "author_name": "Coyote 611",
    "author_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-701/coyote-611/mini.png"
  }
]
GET

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

Show a extra cost of a project

Request

Route

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

Headers

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

cURL

curl -g "https://runrun.it/api/v1.0/projects/1/extra_costs/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 project extra cost integer
description Description about the project extra cost string
date When project extra cost was created date
amount Project extra cost value decimal
project_id Project extra cost associated project ID integer
author_name User's name that created the project extra cost string
author_avatar_url User's avatar that created the project extra cost string

Status

200

Headers

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

Body

{
  "id": 1,
  "description": "Cost 2",
  "date": "2025-06-18",
  "amount": 1000.0,
  "project_id": 1,
  "author_name": "Coyote 613",
  "author_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-702/coyote-613/mini.png"
}
POST

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

Create a new Project Extra Cost

Parameters

Name Description type
project_extra_cost[description] required

Description about the project extra cost

string
project_extra_cost[date] required

When project extra cost was created

date
project_extra_cost[amount] required

Project extra cost value

decimal

Request

Route

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

Headers

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

Body

{
  "project_extra_cost": {
    "description": "Cost 3",
    "date": "2025-06-18",
    "amount": "1000.0"
  }
}

cURL

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

Response

Simulated Response

Status

201

Headers

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

Body

{
  "id": 1,
  "description": "Cost 3",
  "date": "2025-06-18",
  "amount": 1000.0,
  "project_id": 1,
  "author_name": "Coyote 614",
  "author_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-703/coyote-614/mini.png"
}

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

200

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": "2025-06-18T13:26:51-03:00",
    "is_public": true,
    "is_shared": false,
    "sharing_details": [

    ],
    "use_new_permissions": true,
    "board_stage_id": null,
    "client_name": "Test client 297",
    "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

200

Headers

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

Body

{
  "id": 1,
  "name": "Project_A",
  "start_date": null,
  "close_date": null,
  "is_closed": false,
  "client_id": 1,
  "project_group_id": 1,
  "project_sub_group_id": 1,
  "budgeted_cost": 0.0,
  "desired_date": null,
  "created_at": "2025-06-18T13:26:57-03:00",
  "is_public": true,
  "is_shared": false,
  "sharing_details": [

  ],
  "use_new_permissions": true,
  "board_stage_id": null,
  "client_name": "Test client 301",
  "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,
    "start_date": "2025-01-01",
    "desired_date": "2025-01-31"
  }
}

cURL

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

Response

Simulated Response

Status

201

Headers

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

Body

{
  "id": 1,
  "name": "New Project",
  "start_date": "2025-01-01T00:00:00-03:00",
  "close_date": null,
  "is_closed": false,
  "client_id": 1,
  "project_group_id": 1,
  "project_sub_group_id": 1,
  "budgeted_cost": 0.0,
  "desired_date": "2025-01-31T00:00:00-03:00",
  "created_at": "2025-06-18T13:26:58-03:00",
  "is_public": true,
  "is_shared": false,
  "sharing_details": [

  ],
  "use_new_permissions": true,
  "board_stage_id": null,
  "client_name": "Test client 302",
  "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": "hard_overdue",
  "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
}
PUT

/api/v1.0/projects/:id

Deliver the project

Parameters

Name Description type
id required

The unique identifier of the project to be updated.

integer
is_active required

Defines whether the project is active (true) or delivered (false).

boolean

Request

Route

PUT /api/v1.0/projects/1

Headers

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

Body

{
  "is_active": false
}

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": 1,
  "name": "Project_A",
  "start_date": null,
  "close_date": "2025-06-18T13:27:02-03:00",
  "is_closed": true,
  "client_id": 1,
  "project_group_id": 1,
  "project_sub_group_id": 1,
  "budgeted_cost": 0.0,
  "desired_date": null,
  "created_at": "2025-06-18T13:27:02-03:00",
  "is_public": true,
  "is_shared": false,
  "sharing_details": [

  ],
  "use_new_permissions": true,
  "board_stage_id": null,
  "client_name": "Test client 305",
  "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": false
}
PUT

/api/v1.0/projects/:id

Reopen the project

Parameters

Name Description type
id required

The unique identifier of the project to be updated.

integer
is_active required

Defines whether the project is active (true) or delivered (false).

boolean

Request

Route

PUT /api/v1.0/projects/1

Headers

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

Body

{
  "is_active": true
}

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": 1,
  "name": "Project_A",
  "start_date": null,
  "close_date": null,
  "is_closed": false,
  "client_id": 1,
  "project_group_id": 1,
  "project_sub_group_id": 1,
  "budgeted_cost": 0.0,
  "desired_date": null,
  "created_at": "2025-06-18T13:27:03-03:00",
  "is_public": true,
  "is_shared": false,
  "sharing_details": [

  ],
  "use_new_permissions": true,
  "board_stage_id": null,
  "client_name": "Test client 306",
  "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 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

200

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": "2025-06-18T13:27:06-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

200

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": "2025-06-18T13:27:07-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

200

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": "2025-06-18T13:27:08-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

200

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": "2025-06-18T13:27:09-03:00",
  "is_public": true,
  "is_shared": true,
  "sharing_details": [
    "desired_date"
  ],
  "use_new_permissions": true,
  "board_stage_id": null,
  "client_name": "Test client 308",
  "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

200

Headers

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

Body

{
  "id": 1,
  "name": "Project_A",
  "start_date": null,
  "close_date": null,
  "is_closed": false,
  "client_id": 1,
  "project_group_id": 1,
  "project_sub_group_id": 1,
  "budgeted_cost": 0.0,
  "desired_date": null,
  "created_at": "2025-06-18T13:27:11-03:00",
  "is_public": true,
  "is_shared": false,
  "sharing_details": [

  ],
  "use_new_permissions": true,
  "board_stage_id": null,
  "client_name": "Test client 309",
  "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

Request

Route

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

Headers

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

Body

{
  "new_project": {
    "name": "Cloned Project"
  }
}

cURL

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

Response

Simulated Response

Status

200

Headers

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

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

200

Headers

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

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": "2025-06-18T13:27:13-03:00",
  "is_public": true,
  "is_shared": false,
  "sharing_details": [

  ],
  "use_new_permissions": true,
  "board_stage_id": 1,
  "client_name": "Test client 311",
  "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 1",
  "board_stage_color": "#FFFFFF",
  "activities_7_days_ago": 0,
  "time_pending_backlog": 0,
  "tasks_backlog_count": 0,
  "is_active": true
}

Tags

GET

/api/v1.0/tags

Query tags

Parameters

Name Description type
search_term required

Search term for tag name. For a given term will be return a list of tags that match fully or partially with tag name.

string

Request

Route

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

Headers

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

Query Parameters

search_term=tag

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

[

]

Task Description

GET

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

Show the task description

Show the task description.

Request

Route

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

Headers

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

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": 1,
  "description": "Awesome!",
  "current_editor_id": null,
  "current_editor_name": null,
  "edited_at": "2025-06-18T13:29:31-03:00",
  "locked_at": null
}
PUT

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

Update the task description

Update a task description.

Parameters

Name Description type
description

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": 176,
    "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":176,"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

200

Headers

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

Body

{
  "id": 1,
  "description": "Gorgeous!",
  "current_editor_id": null,
  "current_editor_name": null,
  "edited_at": "2025-06-18T13:29:32-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

200

Headers

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

Body

[
  {
    "id": 3,
    "state": "pending",
    "happened_at": null,
    "evaluator_id": "coyote-444",
    "evaluator_name": "Coyote 444",
    "evaluator_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-289/coyote-444/mini.png",
    "evaluator_is_deleted": false,
    "task": {
      "id": 3,
      "title": "Third task",
      "is_working_on": false,
      "user_id": "coyote-443",
      "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": "2025-06-18T13:30: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 275",
      "client_id": 3,
      "project_name": "Test project 294",
      "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 366",
      "user_name": "Coyote 443",
      "guest_name": null,
      "board_name": "Board 245",
      "board_stage_name": "Board Stage 703",
      "board_stage_description": null,
      "team_name": null,
      "type_color": "FFFFFF",
      "state": "queued",
      "overdue": null,
      "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": "2025-06-18T13:30:02-03:00",
      "automation_id": null,
      "automation_name": null,
      "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-443",
          "team_id": null,
          "assignee_name": "Coyote 443",
          "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": "2025-06-18T13:30:02-03:00",
          "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-289/coyote-443/mini.png",
          "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-289/coyote-443/regular.png",
          "time_worked_not_persisted": 0
        }
      ]
    }
  },
  {
    "id": 2,
    "state": "pending",
    "happened_at": null,
    "evaluator_id": "coyote-441",
    "evaluator_name": "Coyote 441",
    "evaluator_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-289/coyote-441/mini.png",
    "evaluator_is_deleted": false,
    "task": {
      "id": 2,
      "title": "Second task",
      "is_working_on": false,
      "user_id": "coyote-442",
      "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": "2025-06-18T13:30: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 274",
      "client_id": 2,
      "project_name": "Test project 293",
      "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 365",
      "user_name": "Coyote 442",
      "guest_name": null,
      "board_name": "Board 244",
      "board_stage_name": "Board Stage 700",
      "board_stage_description": null,
      "team_name": null,
      "type_color": "FFFFFF",
      "state": "queued",
      "overdue": null,
      "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": "2025-06-18T13:30:01-03:00",
      "automation_id": null,
      "automation_name": null,
      "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-442",
          "team_id": null,
          "assignee_name": "Coyote 442",
          "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": "2025-06-18T13:30:01-03:00",
          "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-289/coyote-442/mini.png",
          "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-289/coyote-442/regular.png",
          "time_worked_not_persisted": 0
        }
      ]
    }
  },
  {
    "id": 1,
    "state": "pending",
    "happened_at": null,
    "evaluator_id": "coyote-441",
    "evaluator_name": "Coyote 441",
    "evaluator_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-289/coyote-441/mini.png",
    "evaluator_is_deleted": false,
    "task": {
      "id": 1,
      "title": "First task",
      "is_working_on": false,
      "user_id": "coyote-440",
      "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": "2025-06-18T13:30: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 273",
      "client_id": 1,
      "project_name": "Test project 292",
      "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 364",
      "user_name": "Coyote 440",
      "guest_name": null,
      "board_name": "Board 243",
      "board_stage_name": "Board Stage 697",
      "board_stage_description": null,
      "team_name": null,
      "type_color": "FFFFFF",
      "state": "queued",
      "overdue": null,
      "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": "2025-06-18T13:30:00-03:00",
      "automation_id": null,
      "automation_name": null,
      "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-440",
          "team_id": null,
          "assignee_name": "Coyote 440",
          "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": "2025-06-18T13:30:00-03:00",
          "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-289/coyote-440/mini.png",
          "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-289/coyote-440/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

200

Headers

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

Body

[
  {
    "id": 1,
    "state": "pending",
    "happened_at": null,
    "evaluator_id": "coyote-447",
    "evaluator_name": "Coyote 447",
    "evaluator_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-290/coyote-447/mini.png",
    "evaluator_is_deleted": false,
    "task": {
      "id": 1,
      "title": "First task",
      "is_working_on": false,
      "user_id": "coyote-446",
      "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": "2025-06-18T13:30:04-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 276",
      "client_id": 1,
      "project_name": "Test project 295",
      "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 367",
      "user_name": "Coyote 446",
      "guest_name": null,
      "board_name": "Board 246",
      "board_stage_name": "Board Stage 706",
      "board_stage_description": null,
      "team_name": null,
      "type_color": "FFFFFF",
      "state": "queued",
      "overdue": null,
      "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": "2025-06-18T13:30:04-03:00",
      "automation_id": null,
      "automation_name": null,
      "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-446",
          "team_id": null,
          "assignee_name": "Coyote 446",
          "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": "2025-06-18T13:30:04-03:00",
          "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-290/coyote-446/mini.png",
          "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-290/coyote-446/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-453

Headers

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

Query Parameters

evaluator_id=coyote-453

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

[
  {
    "id": 2,
    "state": "pending",
    "happened_at": null,
    "evaluator_id": "coyote-453",
    "evaluator_name": "Coyote 453",
    "evaluator_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-291/coyote-453/mini.png",
    "evaluator_is_deleted": false,
    "task": {
      "id": 2,
      "title": "Second task",
      "is_working_on": false,
      "user_id": "coyote-454",
      "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": "2025-06-18T13:30:08-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 280",
      "client_id": 2,
      "project_name": "Test project 299",
      "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 371",
      "user_name": "Coyote 454",
      "guest_name": null,
      "board_name": "Board 250",
      "board_stage_name": "Board Stage 718",
      "board_stage_description": null,
      "team_name": null,
      "type_color": "FFFFFF",
      "state": "queued",
      "overdue": null,
      "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": "2025-06-18T13:30:08-03:00",
      "automation_id": null,
      "automation_name": null,
      "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-454",
          "team_id": null,
          "assignee_name": "Coyote 454",
          "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": "2025-06-18T13:30:08-03:00",
          "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-291/coyote-454/mini.png",
          "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-291/coyote-454/regular.png",
          "time_worked_not_persisted": 0
        }
      ]
    }
  },
  {
    "id": 1,
    "state": "pending",
    "happened_at": null,
    "evaluator_id": "coyote-453",
    "evaluator_name": "Coyote 453",
    "evaluator_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-291/coyote-453/mini.png",
    "evaluator_is_deleted": false,
    "task": {
      "id": 1,
      "title": "First task",
      "is_working_on": false,
      "user_id": "coyote-452",
      "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": "2025-06-18T13:30:07-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 279",
      "client_id": 1,
      "project_name": "Test project 298",
      "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 370",
      "user_name": "Coyote 452",
      "guest_name": null,
      "board_name": "Board 249",
      "board_stage_name": "Board Stage 715",
      "board_stage_description": null,
      "team_name": null,
      "type_color": "FFFFFF",
      "state": "queued",
      "overdue": null,
      "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": "2025-06-18T13:30:07-03:00",
      "automation_id": null,
      "automation_name": null,
      "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-452",
          "team_id": null,
          "assignee_name": "Coyote 452",
          "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": "2025-06-18T13:30:07-03:00",
          "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-291/coyote-452/mini.png",
          "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-291/coyote-452/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

200

Headers

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

Body

{
  "id": 1,
  "state": "pending",
  "happened_at": null,
  "evaluator_id": "coyote-459",
  "evaluator_name": "Coyote 459",
  "evaluator_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-292/coyote-459/mini.png",
  "evaluator_is_deleted": false,
  "task": {
    "id": 1,
    "title": "First task",
    "is_working_on": false,
    "user_id": "coyote-458",
    "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": "2025-06-18T13:30:10-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 282",
    "client_id": 1,
    "project_name": "Test project 301",
    "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 373",
    "user_name": "Coyote 458",
    "guest_name": null,
    "board_name": "Board 252",
    "board_stage_name": "Board Stage 724",
    "board_stage_description": null,
    "team_name": null,
    "type_color": "FFFFFF",
    "state": "queued",
    "overdue": null,
    "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-459"
    ],
    "pending_evaluator_ids": [
      "coyote-459"
    ],
    "approved_evaluator_ids": [

    ],
    "rejected_evaluator_ids": [

    ],
    "custom_fields": {
    },
    "form_id": null,
    "last_activity_at": "2025-06-18T13:30:11-03:00",
    "automation_id": null,
    "automation_name": null,
    "priority": 1,
    "tag_list": "",
    "tags": [

    ],
    "scheduled_start_time": null,
    "is_scheduled": false,
    "current_evaluator_id": "coyote-459",
    "assignments": [
      {
        "id": "49537adb9",
        "task_id": 1,
        "assignee_id": "coyote-458",
        "team_id": null,
        "assignee_name": "Coyote 458",
        "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": "2025-06-18T13:30:10-03:00",
        "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-292/coyote-458/mini.png",
        "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-292/coyote-458/regular.png",
        "time_worked_not_persisted": 0
      }
    ]
  }
}
DELETE

/api/v1.0/task_evaluations/:id

Destroy a task evaluation

Request

Route

DELETE /api/v1.0/task_evaluations/1

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

Response

Simulated Response

Status

204

Headers

Task Evaluations

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-584"
    },
    {
      "evaluator_id": "coyote-585"
    }
  ]
}

cURL

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

Response

Simulated Response

Status

201

Headers

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

Body

{
  "id": 1,
  "title": "Bla 422",
  "is_working_on": false,
  "user_id": "coyote-583",
  "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": "2025-06-18T13:35:45-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 446",
  "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 418",
  "user_name": "Coyote 583",
  "guest_name": null,
  "board_name": "Board 367",
  "board_stage_name": "Board Stage 1090",
  "board_stage_description": null,
  "team_name": null,
  "type_color": "FFFFFF",
  "state": "queued",
  "overdue": null,
  "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-584",
    "coyote-585"
  ],
  "pending_evaluator_ids": [
    "coyote-584",
    "coyote-585"
  ],
  "approved_evaluator_ids": [

  ],
  "rejected_evaluator_ids": [

  ],
  "custom_fields": {
  },
  "form_id": null,
  "last_activity_at": "2025-06-18T13:35:45-03:00",
  "automation_id": null,
  "automation_name": null,
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": "coyote-584",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-583",
      "team_id": null,
      "assignee_name": "Coyote 583",
      "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": "2025-06-18T13:35:45-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-472/coyote-583/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-472/coyote-583/regular.png",
      "time_worked_not_persisted": 0
    }
  ]
}
DELETE

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

Destroy all evaluations for this task

Request

Route

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

Headers

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

cURL

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

Response

Simulated Response

Status

204

Headers

Task Followers

GET

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

List all followers

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

Request

Route

GET /api/v1.0/tasks/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

200

Headers

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

Body

[
  {
    "id": "coyote-646",
    "name": "Coyote 646",
    "email": "coyote680@acme.foo",
    "avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-354/coyote-646/mini.png",
    "avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-354/coyote-646/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": "2025-06-18T13:33:54-03:00",
    "in_company_since": null,
    "is_certified": false,
    "is_certified_expert": false,
    "language": "en-US",
    "alt_id": "ba0261f7bde001a1f179b02cd34e6ff9",
    "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-648"
}

cURL

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

Response

Simulated Response

Status

201

Headers

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

Body

{
  "id": "coyote-648",
  "name": "Coyote 648",
  "email": "coyote682@acme.foo",
  "avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-355/coyote-648/mini.png",
  "avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-355/coyote-648/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": "2025-06-18T13:33:56-03:00",
  "in_company_since": null,
  "is_certified": false,
  "is_certified_expert": false,
  "language": "en-US",
  "alt_id": "6f7528a2b8b990a395892047de37c51d",
  "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

Request

Route

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

Headers

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

cURL

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

Response

Simulated Response

Status

204

Headers

Task Templates

GET

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

List all Task Templates of this Project Template

Request

Route

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

Headers

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

cURL

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

200

Headers

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

Body

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

    ],
    "created_at": "2025-06-18T13:34:32-03:00",
    "follower_ids": [

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

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

    ],
    "created_at": "2025-06-18T13:34:32-03:00",
    "follower_ids": [

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

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

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

Show a Task Template

Request

Route

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

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

Response

Simulated Response

Status

200

Headers

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

Body

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

  ],
  "created_at": "2025-06-18T13:34:33-03:00",
  "follower_ids": [

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

  ],
  "responsible_id": null,
  "assignments": [
    {
      "id": "49537adb9",
      "task_template_id": 3,
      "assignee_id": "coyote-476",
      "team_id": null,
      "assignee_name": "Coyote 476",
      "team_name": null
    }
  ],
  "workflow_id": null
}
POST

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

Create a Task Template

Parameters

Name Description type
title

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-477",
        "team_id": 1
      }
    ],
    "subtasks_data": [
      {
        "title": "Subtarefa 1",
        "desired_date": "2021-02-21 10:30 0300",
        "assignments_data": [
          {
            "assignee_id": "coyote-477",
            "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-477","team_id":1}],"subtasks_data":[{"title":"Subtarefa 1","desired_date":"2021-02-21 10:30 0300","assignments_data":[{"assignee_id":"coyote-477","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

201

Headers

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

Body

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

  ],
  "created_at": "2025-06-18T13:34:35-03:00",
  "follower_ids": [

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

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-480",
        "team_id": 1
      }
    ],
    "subtasks_data": [
      {
        "title": "Subtarefa 1",
        "desired_date": "2021-02-21 10:30 0300",
        "assignments_data": [
          {
            "assignee_id": "coyote-479",
            "team_id": 1
          }
        ]
      }
    ]
  }
}

cURL

curl "https://runrun.it/api/v1.0/project_templates/1/task_templates/5" -d '{"task_template":{"title":"New Title","type_id":1,"assignments":[{"assignee_id":"coyote-480","team_id":1}],"subtasks_data":[{"title":"Subtarefa 1","desired_date":"2021-02-21 10:30 0300","assignments_data":[{"assignee_id":"coyote-479","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

200

Headers

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

Body

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

  ],
  "created_at": "2025-06-18T13:34:36-03:00",
  "follower_ids": [

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

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

Destroy a Task Template

Request

Route

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

Headers

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

cURL

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

Response

Simulated Response

Status

204

Headers

Task Workflows

GET

/api/v1.0/workflows

Show a Workflow

Parameters

Name Description type
task_id required

ID of the task the workflow belongs to

integer

Request

Route

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

Headers

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

Query Parameters

task_id=1

cURL

curl -g "https://runrun.it/api/v1.0/workflows?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

200

Headers

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

Body

{
  "id": 1,
  "workable_id": 1,
  "workable_type": "Task",
  "task_id": 1,
  "current_workflow_element_id": 1,
  "is_last_element": true,
  "is_first_element": true
}
POST

/api/v1.0/workflows

Create a Workflow

The workflow is eligible to be created if:

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

Parameters

Name Description type
task_id required

ID of the task the workflow belongs to

integer

Request

Route

POST /api/v1.0/workflows

Headers

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

Body

{
  "task_id": 1
}

cURL

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

Response

Simulated Response

Status

201

Headers

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

Body

{
  "id": 1,
  "workable_id": 1,
  "workable_type": "Task",
  "task_id": 1,
  "current_workflow_element_id": 1,
  "is_last_element": true,
  "is_first_element": true
}
DELETE

/api/v1.0/workflows

Destroy a workflow

Parameters

Name Description type
task_id required

ID of the task the workflow belongs to

integer

Request

Route

DELETE /api/v1.0/workflows

Headers

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

Body

{
  "task_id": 1
}

cURL

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

Response

Simulated Response

Status

204

Headers

TaskAssignments

DELETE

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

Destroy a task assignment for another user

Destroy a task assignment.

Parameters

Name Description type default
id required

ID of assignment

string
task_id required

ID of task

integer
destroy_worked_time

Destroy worked time

boolean

Request

Route

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

Headers

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

Body

{
  "destroy_worked_time": false
}

cURL

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

Response

Simulated Response

Status

204

Headers

POST

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

Play a Task

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

The task is eligible to be started if:

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

Parameters

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

200

Headers

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

Body

{
  "id": "49537adb9",
  "task_id": 1,
  "assignee_id": "coyote-357",
  "team_id": null,
  "assignee_name": "Coyote 357",
  "team_name": null,
  "queue_position": 1,
  "priority": 1,
  "current_estimate_seconds": 3600,
  "time_worked": 0,
  "estimated_start_date": null,
  "estimate_updated": false,
  "start_date": "2025-06-18T13:28:36-03:00",
  "close_date": null,
  "is_closed": false,
  "reestimate_count": 0,
  "is_working_on": true,
  "automatic_time_worked_updated_at": "2025-06-18T13:28:36-03:00",
  "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-199/coyote-357/mini.png",
  "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-199/coyote-357/regular.png",
  "time_worked_not_persisted": 0
}
POST

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

Pause a task assignment

Pause the work on a task.

The task is eligible to be paused if:

  • it's currently being working on

Parameters

Name Description type
id required

ID of assignment

string
task_id required

ID of task

integer

Request

Route

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

Headers

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

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "49537adb9",
  "task_id": 1,
  "assignee_id": "coyote-360",
  "team_id": null,
  "assignee_name": "Coyote 360",
  "team_name": null,
  "queue_position": 1,
  "priority": 1,
  "current_estimate_seconds": 3600,
  "time_worked": 0,
  "estimated_start_date": "2025-06-18T13:28:39-03:00",
  "estimate_updated": false,
  "start_date": "2025-06-18T13:28:38-03:00",
  "close_date": null,
  "is_closed": false,
  "reestimate_count": 0,
  "is_working_on": false,
  "automatic_time_worked_updated_at": "2025-06-18T13:28:39-03:00",
  "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-201/coyote-360/mini.png",
  "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-201/coyote-360/regular.png",
  "time_worked_not_persisted": 0
}
POST

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

Deliver a task assignment

Deliver a task.

The task is eligible to be delivered if:

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

Parameters

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

200

Headers

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

Body

{
  "id": "49537adb9",
  "task_id": 1,
  "assignee_id": "coyote-363",
  "team_id": null,
  "assignee_name": "Coyote 363",
  "team_name": null,
  "queue_position": null,
  "priority": null,
  "current_estimate_seconds": 3600,
  "time_worked": 0,
  "estimated_start_date": null,
  "estimate_updated": true,
  "start_date": "2025-06-18T13:28:41-03:00",
  "close_date": "2025-06-18T13:28:41-03:00",
  "is_closed": true,
  "reestimate_count": 0,
  "is_working_on": false,
  "automatic_time_worked_updated_at": "2025-06-18T13:28:41-03:00",
  "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-203/coyote-363/mini.png",
  "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-203/coyote-363/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

200

Headers

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

Body

{
  "id": "49537adb9",
  "task_id": 1,
  "assignee_id": "coyote-370",
  "team_id": null,
  "assignee_name": "Coyote 370",
  "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": "2025-06-18T13:28:46-03:00",
  "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-207/coyote-370/mini.png",
  "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-207/coyote-370/regular.png",
  "time_worked_not_persisted": 0
}
POST

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

Reposition a Task

Parameters

Name Description type
id required

ID of assignment

string
queue_position required

The new queue position on assignee user's task list

integer

Request

Route

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

Headers

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

Body

{
  "queue_position": 2
}

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "dbfa7092b",
  "task_id": 3,
  "assignee_id": "coyote-373",
  "team_id": null,
  "assignee_name": "Coyote 373",
  "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": "2025-06-18T13:28:49-03:00",
  "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-209/coyote-373/mini.png",
  "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-209/coyote-373/regular.png",
  "time_worked_not_persisted": 0
}
POST

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

Reestimate a task assignment

Parameters

Name Description type
id required

ID of assignment

string
task_id required

ID of task

integer
work_seconds required

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

200

Headers

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

Body

{
  "id": "49537adb9",
  "task_id": 1,
  "assignee_id": "coyote-376",
  "team_id": null,
  "assignee_name": "Coyote 376",
  "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": "2025-06-18T13:28:51-03:00",
  "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-211/coyote-376/mini.png",
  "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-211/coyote-376/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

200

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": "2025-06-18T13:30:36-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

200

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": "2025-06-18T13:30:37-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

201

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": "2025-06-18T13:30:38-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

200

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": "2025-06-18T13:30:39-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-2&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-2
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-2&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

200

Headers

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

Body

[
  {
    "id": 2,
    "title": "Improve Task API",
    "is_working_on": false,
    "user_id": "coyote-4",
    "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": "2025-06-17T13:22:50-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": "2025-06-18T13:22:50-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 1",
    "client_id": 1,
    "project_name": "Test project 1",
    "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 2",
    "user_name": "Coyote 4",
    "guest_name": null,
    "board_name": "Board 2",
    "board_stage_name": "Board Stage 4",
    "board_stage_description": null,
    "team_name": null,
    "type_color": "FFFFFF",
    "state": "closed",
    "overdue": null,
    "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": "2025-06-18T13:22:50-03:00",
    "automation_id": null,
    "automation_name": null,
    "priority": 2,
    "tag_list": "",
    "tags": [

    ],
    "scheduled_start_time": null,
    "is_scheduled": false,
    "current_evaluator_id": null,
    "uid": 2,
    "responsible_id": "coyote-2",
    "task_state_id": 4,
    "responsible_name": "Coyote 2",
    "task_state_name": "Board Stage 4",
    "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 4",
    "assignments": [
      {
        "id": "92a6f5b72",
        "task_id": 2,
        "assignee_id": "coyote-2",
        "team_id": null,
        "assignee_name": "Coyote 2",
        "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": "2025-06-18T13:22:50-03:00",
        "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-1/coyote-2/mini.png",
        "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-1/coyote-2/regular.png",
        "time_worked_not_persisted": 0
      }
    ],
    "follower_ids": [

    ]
  },
  {
    "id": 1,
    "title": "Create Task API",
    "is_working_on": false,
    "user_id": "coyote-3",
    "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": "2025-06-16T13:22:49-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": "2025-06-18T13:22: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 1",
    "client_id": 1,
    "project_name": "Test project 1",
    "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 1",
    "user_name": "Coyote 3",
    "guest_name": null,
    "board_name": "Board 1",
    "board_stage_name": "Board Stage 1",
    "board_stage_description": null,
    "team_name": null,
    "type_color": "FFFFFF",
    "state": "closed",
    "overdue": null,
    "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": "2025-06-18T13:22:49-03:00",
    "automation_id": null,
    "automation_name": null,
    "priority": 1,
    "tag_list": "",
    "tags": [

    ],
    "scheduled_start_time": null,
    "is_scheduled": false,
    "current_evaluator_id": null,
    "uid": 1,
    "responsible_id": "coyote-2",
    "task_state_id": 1,
    "responsible_name": "Coyote 2",
    "task_state_name": "Board Stage 1",
    "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 1",
    "assignments": [
      {
        "id": "49537adb9",
        "task_id": 1,
        "assignee_id": "coyote-2",
        "team_id": null,
        "assignee_name": "Coyote 2",
        "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": "2025-06-18T13:22:49-03:00",
        "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-1/coyote-2/mini.png",
        "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-1/coyote-2/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
description Task description 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
automation_id ID of the automation that created the task integer
automation_name Name of the automation that created the task string
priority [Deprecated] Use queue_position integer
tag_list [Deprecated] Use tags_data string
tags [Deprecated] Use tags_data array
scheduled_start_time [Deprecated] Use desired_start_date datetime
is_scheduled [Deprecated] Not used anymore boolean
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

200

Headers

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

Body

{
  "id": 1,
  "title": "Bla 1",
  "is_working_on": false,
  "user_id": "coyote-43",
  "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": "2025-06-18T13:23: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 14",
  "client_id": 1,
  "project_name": "Test project 14",
  "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 20",
  "user_name": "Coyote 43",
  "guest_name": null,
  "board_name": "Board 20",
  "board_stage_name": "Board Stage 58",
  "board_stage_description": null,
  "team_name": null,
  "type_color": "FFFFFF",
  "state": "queued",
  "overdue": null,
  "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": "2025-06-18T13:23:16-03:00",
  "automation_id": null,
  "automation_name": null,
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 1,
  "responsible_id": "coyote-42",
  "task_state_id": 1,
  "responsible_name": "Coyote 42",
  "task_state_name": "Board Stage 58",
  "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 58",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-42",
      "team_id": null,
      "assignee_name": "Coyote 42",
      "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": "2025-06-18T13:23:16-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-12/coyote-42/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-12/coyote-42/regular.png",
      "time_worked_not_persisted": 0
    }
  ],
  "follower_ids": [

  ],
  "unseen_since": "2025-06-18T13:23:17-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
description Task description 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
automation_id ID of the automation that created the task integer
automation_name Name of the automation that created the task string
priority [Deprecated] Use queue_position integer
tag_list [Deprecated] Use tags_data string
tags [Deprecated] Use tags_data array
scheduled_start_time [Deprecated] Use desired_start_date datetime
is_scheduled [Deprecated] Not used anymore boolean
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

200

Headers

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

Body

[
  {
    "id": 2,
    "title": "Subtask",
    "is_working_on": false,
    "user_id": "coyote-46",
    "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": "2025-06-18T13:23: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 16",
    "client_id": 2,
    "project_name": "Test project 16",
    "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 22",
    "user_name": "Coyote 46",
    "guest_name": null,
    "board_name": "Board 22",
    "board_stage_name": "Board Stage 64",
    "board_stage_description": null,
    "team_name": null,
    "type_color": "FFFFFF",
    "state": "queued",
    "overdue": null,
    "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": "2025-06-18T13:23:18-03:00",
    "automation_id": null,
    "automation_name": null,
    "priority": 2,
    "tag_list": "",
    "tags": [

    ],
    "scheduled_start_time": null,
    "is_scheduled": false,
    "current_evaluator_id": null,
    "uid": 2,
    "responsible_id": "coyote-44",
    "task_state_id": 4,
    "responsible_name": "Coyote 44",
    "task_state_name": "Board Stage 64",
    "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 64",
    "assignments": [
      {
        "id": "92a6f5b72",
        "task_id": 2,
        "assignee_id": "coyote-44",
        "team_id": null,
        "assignee_name": "Coyote 44",
        "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": "2025-06-18T13:23:18-03:00",
        "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-13/coyote-44/mini.png",
        "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-13/coyote-44/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 8",
    "desired_date": null,
    "on_going": false,
    "assignments": [
      {
        "assignee_id": "coyote-57",
        "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 8","desired_date":null,"on_going":false,"assignments":[{"assignee_id":"coyote-57","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

201

Headers

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

Body

{
  "id": 1,
  "title": "Bla 8",
  "is_working_on": false,
  "user_id": "coyote-57",
  "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": "2025-06-18T13:23:26-03:00",
  "queue_position": 1,
  "created_at": "2025-06-18T13:23: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 22",
  "client_id": 1,
  "project_name": "Test project 22",
  "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 28",
  "user_name": "Coyote 57",
  "guest_name": null,
  "board_name": "Board 28",
  "board_stage_name": "Board Stage 82",
  "board_stage_description": null,
  "team_name": "Test team 1",
  "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": "2025-06-18T13:23:26-03:00",
  "automation_id": null,
  "automation_name": null,
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 1,
  "responsible_id": "coyote-57",
  "task_state_id": 1,
  "responsible_name": "Coyote 57",
  "task_state_name": "Board Stage 82",
  "activities_7_days_ago": 0,
  "repetition_rule_id": null,
  "current_worked_time": 0,
  "estimated_delivery_date_updated": true,
  "last_estimated_at": "2025-06-18T13:23:26-03:00",
  "task_tags": [

  ],
  "approved": null,
  "task_status_id": 1,
  "task_status_name": "Board Stage 82",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-57",
      "team_id": 1,
      "assignee_name": "Coyote 57",
      "team_name": "Test team 1",
      "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": "2025-06-18T13:23:26-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-15/coyote-57/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-15/coyote-57/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

200

Headers

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

Body

{
  "id": 1,
  "title": "New title",
  "is_working_on": false,
  "user_id": "coyote-93",
  "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": "2025-06-18T13:23: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 34",
  "client_id": 1,
  "project_name": "Test project 34",
  "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 45",
  "user_name": "Coyote 93",
  "guest_name": null,
  "board_name": "Board 55",
  "board_stage_name": "Board Stage 163",
  "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": "2025-06-18T13:23:54-03:00",
  "automation_id": null,
  "automation_name": null,
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 1,
  "responsible_id": "coyote-93",
  "task_state_id": 1,
  "responsible_name": "Coyote 93",
  "task_state_name": "Board Stage 163",
  "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 163",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-93",
      "team_id": null,
      "assignee_name": "Coyote 93",
      "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": "2025-06-18T13:23:54-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-38/coyote-93/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-38/coyote-93/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

200

Headers

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

Body

{
  "id": 1,
  "title": "Bla 19",
  "is_working_on": false,
  "user_id": "coyote-95",
  "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-17T15:50:30-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": "2025-06-18T13:23:55-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 35",
  "client_id": 1,
  "project_name": "Test project 35",
  "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 46",
  "user_name": "Coyote 95",
  "guest_name": null,
  "board_name": "Board 56",
  "board_stage_name": "Board Stage 166",
  "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": "2025-06-18T13:23:56-03:00",
  "automation_id": null,
  "automation_name": null,
  "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-95",
  "task_state_id": 1,
  "responsible_name": "Coyote 95",
  "task_state_name": "Board Stage 166",
  "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 166",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-95",
      "team_id": null,
      "assignee_name": "Coyote 95",
      "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": "2025-06-18T13:23:55-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-39/coyote-95/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-39/coyote-95/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

200

Headers

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

Body

{
  "id": 1,
  "title": "Bla 21",
  "is_working_on": false,
  "user_id": "coyote-99",
  "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-20T19:23:40-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": "2025-06-18T13:23:59-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 37",
  "client_id": 1,
  "project_name": "Test project 37",
  "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 48",
  "user_name": "Coyote 99",
  "guest_name": null,
  "board_name": "Board 58",
  "board_stage_name": "Board Stage 172",
  "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": "2025-06-18T13:23:59-03:00",
  "automation_id": null,
  "automation_name": null,
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 1,
  "responsible_id": "coyote-99",
  "task_state_id": 1,
  "responsible_name": "Coyote 99",
  "task_state_name": "Board Stage 172",
  "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 172",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-99",
      "team_id": null,
      "assignee_name": "Coyote 99",
      "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": "2025-06-18T13:23:59-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-41/coyote-99/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-41/coyote-99/regular.png",
      "time_worked_not_persisted": 0
    }
  ],
  "follower_ids": [

  ]
}
PUT

/api/v1.0/tasks/:id

Add task tags, without setting the color

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

200

Headers

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

Body

{
  "id": 1,
  "title": "Bla 23",
  "is_working_on": false,
  "user_id": "coyote-103",
  "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": "2025-06-18T13:24:02-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": null
    },
    {
      "name": "tag b",
      "color": null
    }
  ],
  "client_name": "Test client 39",
  "client_id": 1,
  "project_name": "Test project 39",
  "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 50",
  "user_name": "Coyote 103",
  "guest_name": null,
  "board_name": "Board 60",
  "board_stage_name": "Board Stage 178",
  "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": "2025-06-18T13:24:03-03:00",
  "automation_id": null,
  "automation_name": null,
  "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-103",
  "task_state_id": 1,
  "responsible_name": "Coyote 103",
  "task_state_name": "Board Stage 178",
  "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 178",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-103",
      "team_id": null,
      "assignee_name": "Coyote 103",
      "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": "2025-06-18T13:24:02-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-43/coyote-103/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-43/coyote-103/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

200

Headers

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

Body

{
  "id": 1,
  "title": "Bla 28",
  "is_working_on": false,
  "user_id": "coyote-113",
  "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": "2025-06-18T13:24:12-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 44",
  "client_id": 1,
  "project_name": "Test project 44",
  "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 55",
  "user_name": "Coyote 113",
  "guest_name": null,
  "board_name": "Board 65",
  "board_stage_name": "Board Stage 193",
  "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": "2025-06-18T13:24:12-03:00",
  "automation_id": null,
  "automation_name": null,
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 1,
  "responsible_id": "coyote-113",
  "task_state_id": 1,
  "responsible_name": "Coyote 113",
  "task_state_name": "Board Stage 193",
  "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 193",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-113",
      "team_id": null,
      "assignee_name": "Coyote 113",
      "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": "2025-06-18T13:24:12-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-48/coyote-113/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-48/coyote-113/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": "Short text",
      "custom_4": "Long text",
      "custom_5": 45,
      "custom_6": 30.23,
      "custom_7": 8,
      "custom_8": "2024-11-15",
      "custom_9": "2024-11-15T21:12:43-03:00",
      "custom_1": {
        "id": "2",
        "label": "Option 2",
        "color": null
      },
      "custom_2": [
        {
          "id": "3",
          "label": "Option A",
          "color": null
        },
        {
          "id": "4",
          "label": "Option B",
          "color": null
        }
      ]
    }
  }
}

cURL

curl "https://runrun.it/api/v1.0/tasks/1" -d '{"task":{"custom_fields":{"custom_3":"Short text","custom_4":"Long text","custom_5":45,"custom_6":30.23,"custom_7":8,"custom_8":"2024-11-15","custom_9":"2024-11-15T21:12:43-03:00","custom_1":{"id":"2","label":"Option 2","color":null},"custom_2":[{"id":"3","label":"Option A","color":null},{"id":"4","label":"Option B","color":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

200

Headers

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

Body

{
  "id": 1,
  "title": "Bla 31",
  "is_working_on": false,
  "user_id": "coyote-119",
  "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": "2025-06-18T13:24:17-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 47",
  "client_id": 1,
  "project_name": "Test project 47",
  "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 58",
  "user_name": "Coyote 119",
  "guest_name": null,
  "board_name": "Board 68",
  "board_stage_name": "Board Stage 202",
  "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",
      "color": null,
      "label": "Option 2"
    },
    "custom_2": [
      {
        "id": "3",
        "color": null,
        "label": "Option A"
      },
      {
        "id": "4",
        "color": null,
        "label": "Option B"
      }
    ],
    "custom_3": "Short text",
    "custom_4": "Long text",
    "custom_5": 45,
    "custom_6": 30.23,
    "custom_7": 8,
    "custom_8": "2024-11-15",
    "custom_9": "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": "2025-06-18T13:24:17-03:00",
  "automation_id": null,
  "automation_name": null,
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 1,
  "responsible_id": "coyote-119",
  "task_state_id": 1,
  "responsible_name": "Coyote 119",
  "task_state_name": "Board Stage 202",
  "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 202",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-119",
      "team_id": null,
      "assignee_name": "Coyote 119",
      "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": "2025-06-18T13:24:17-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-51/coyote-119/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-51/coyote-119/regular.png",
      "time_worked_not_persisted": 0
    }
  ],
  "follower_ids": [

  ]
}
DELETE

/api/v1.0/tasks/:id

Destroy a Task

Request

Route

DELETE /api/v1.0/tasks/1

Headers

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

cURL

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

Response

Simulated Response

Status

204

Headers

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

200

Headers

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

Body

{
  "id": 1,
  "title": "Bla 41",
  "is_working_on": true,
  "user_id": "coyote-141",
  "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": "2025-06-18T13:24:36-03:00",
  "start_date": "2025-06-18T13:24:37-03:00",
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 57",
  "client_id": 1,
  "project_name": "Test project 57",
  "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 68",
  "user_name": "Coyote 141",
  "guest_name": null,
  "board_name": "Board 78",
  "board_stage_name": "Board Stage 232",
  "board_stage_description": null,
  "team_name": null,
  "type_color": "FFFFFF",
  "state": "working_on",
  "overdue": null,
  "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": "2025-06-18T13:24:37-03:00",
  "automation_id": null,
  "automation_name": null,
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 1,
  "responsible_id": "coyote-140",
  "task_state_id": 1,
  "responsible_name": "Coyote 140",
  "task_state_name": "Board Stage 232",
  "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 232",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-140",
      "team_id": null,
      "assignee_name": "Coyote 140",
      "team_name": null,
      "queue_position": 1,
      "priority": 1,
      "current_estimate_seconds": 3600,
      "time_worked": 0,
      "estimated_start_date": null,
      "estimate_updated": false,
      "start_date": "2025-06-18T13:24:37-03:00",
      "close_date": null,
      "is_closed": false,
      "reestimate_count": 0,
      "is_working_on": true,
      "automatic_time_worked_updated_at": "2025-06-18T13:24:37-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-61/coyote-140/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-61/coyote-140/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

200

Headers

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

Body

{
  "id": 1,
  "title": "Bla 42",
  "is_working_on": true,
  "user_id": "coyote-143",
  "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": "2025-06-18T13:24:38-03:00",
  "start_date": "2025-06-18T13:24:39-03:00",
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 58",
  "client_id": 1,
  "project_name": "Test project 58",
  "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 69",
  "user_name": "Coyote 143",
  "guest_name": null,
  "board_name": "Board 79",
  "board_stage_name": "Board Stage 235",
  "board_stage_description": null,
  "team_name": null,
  "type_color": "FFFFFF",
  "state": "working_on",
  "overdue": null,
  "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": "2025-06-18T13:24:38-03:00",
  "automation_id": null,
  "automation_name": null,
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 1,
  "responsible_id": "coyote-142",
  "task_state_id": 1,
  "responsible_name": "Coyote 142",
  "task_state_name": "Board Stage 235",
  "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 235",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-142",
      "team_id": null,
      "assignee_name": "Coyote 142",
      "team_name": null,
      "queue_position": 1,
      "priority": 1,
      "current_estimate_seconds": 3600,
      "time_worked": 0,
      "estimated_start_date": null,
      "estimate_updated": false,
      "start_date": "2025-06-18T13:24:39-03:00",
      "close_date": null,
      "is_closed": false,
      "reestimate_count": 0,
      "is_working_on": true,
      "automatic_time_worked_updated_at": "2025-06-18T13:24:39-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-62/coyote-142/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-62/coyote-142/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

200

Headers

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

Body

{
  "id": 1,
  "title": "Bla 43",
  "is_working_on": false,
  "user_id": "coyote-145",
  "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": "2025-06-18T13:24:40-03:00",
  "start_date": "2025-06-18T13:24:41-03:00",
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 59",
  "client_id": 1,
  "project_name": "Test project 59",
  "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 70",
  "user_name": "Coyote 145",
  "guest_name": null,
  "board_name": "Board 80",
  "board_stage_name": "Board Stage 238",
  "board_stage_description": null,
  "team_name": null,
  "type_color": "FFFFFF",
  "state": "queued",
  "overdue": null,
  "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": "2025-06-18T13:24:41-03:00",
  "automation_id": null,
  "automation_name": null,
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 1,
  "responsible_id": "coyote-145",
  "task_state_id": 1,
  "responsible_name": "Coyote 145",
  "task_state_name": "Board Stage 238",
  "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 238",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-144",
      "team_id": null,
      "assignee_name": "Coyote 144",
      "team_name": null,
      "queue_position": 1,
      "priority": 1,
      "current_estimate_seconds": 3600,
      "time_worked": 0,
      "estimated_start_date": "2025-06-18T13:24:41-03:00",
      "estimate_updated": false,
      "start_date": "2025-06-18T13:24:41-03:00",
      "close_date": null,
      "is_closed": false,
      "reestimate_count": 0,
      "is_working_on": false,
      "automatic_time_worked_updated_at": "2025-06-18T13:24:41-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-63/coyote-144/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-63/coyote-144/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

200

Headers

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

Body

{
  "id": 1,
  "title": "Bla 46",
  "is_working_on": false,
  "user_id": "coyote-150",
  "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": "2025-06-18T13:24:45-03:00",
  "queue_position": 1,
  "created_at": "2025-06-18T13:24: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 62",
  "client_id": 1,
  "project_name": "Test project 62",
  "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 73",
  "user_name": "Coyote 150",
  "guest_name": null,
  "board_name": "Board 84",
  "board_stage_name": "Board Stage 249",
  "board_stage_description": null,
  "team_name": null,
  "type_color": "FFFFFF",
  "state": "queued",
  "overdue": null,
  "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": "2025-06-18T13:24:45-03:00",
  "automation_id": null,
  "automation_name": null,
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 1,
  "responsible_id": "coyote-149",
  "task_state_id": 3,
  "responsible_name": "Coyote 149",
  "task_state_name": "Board Stage 249",
  "activities_7_days_ago": 0,
  "repetition_rule_id": null,
  "current_worked_time": 0,
  "estimated_delivery_date_updated": true,
  "last_estimated_at": "2025-06-18T13:24:45-03:00",
  "task_tags": [

  ],
  "approved": null,
  "task_status_id": 3,
  "task_status_name": "Board Stage 249",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-149",
      "team_id": null,
      "assignee_name": "Coyote 149",
      "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": "2025-06-18T13:24:45-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-65/coyote-149/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-65/coyote-149/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

200

Headers

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

Body

{
  "id": 1,
  "title": "Bla 47",
  "is_working_on": false,
  "user_id": "coyote-152",
  "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": "2025-06-18T13:24: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 63",
  "client_id": 1,
  "project_name": "Test project 63",
  "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 74",
  "user_name": "Coyote 152",
  "guest_name": null,
  "board_name": "Board 85",
  "board_stage_name": "Board Stage 251",
  "board_stage_description": null,
  "team_name": null,
  "type_color": "FFFFFF",
  "state": "queued",
  "overdue": null,
  "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": "2025-06-18T13:24:47-03:00",
  "automation_id": null,
  "automation_name": null,
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 1,
  "responsible_id": "coyote-151",
  "task_state_id": 1,
  "responsible_name": "Coyote 151",
  "task_state_name": "Board Stage 251",
  "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 251",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-151",
      "team_id": null,
      "assignee_name": "Coyote 151",
      "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": "2025-06-18T13:24:47-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-66/coyote-151/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-66/coyote-151/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

200

Headers

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

Body

{
  "id": 1,
  "title": "Bla 49",
  "is_working_on": false,
  "user_id": "coyote-156",
  "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": "2025-06-18T13:24:51-03:00",
  "queue_position": 1,
  "created_at": "2025-06-18T13:24:50-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 65",
  "client_id": 1,
  "project_name": "Test project 66",
  "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 76",
  "user_name": "Coyote 156",
  "guest_name": null,
  "board_name": "Board 87",
  "board_stage_name": "Board Stage 257",
  "board_stage_description": null,
  "team_name": null,
  "type_color": "FFFFFF",
  "state": "queued",
  "overdue": null,
  "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": "2025-06-18T13:24:51-03:00",
  "automation_id": null,
  "automation_name": null,
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 1,
  "responsible_id": "coyote-156",
  "task_state_id": 1,
  "responsible_name": "Coyote 156",
  "task_state_name": "Board Stage 257",
  "activities_7_days_ago": 0,
  "repetition_rule_id": null,
  "current_worked_time": 0,
  "estimated_delivery_date_updated": true,
  "last_estimated_at": "2025-06-18T13:24:51-03:00",
  "task_tags": [

  ],
  "approved": null,
  "task_status_id": 1,
  "task_status_name": "Board Stage 257",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-156",
      "team_id": null,
      "assignee_name": "Coyote 156",
      "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": "2025-06-18T13:24:50-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-68/coyote-156/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-68/coyote-156/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

200

Headers

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

Body

{
  "id": 1,
  "title": "Bla 52",
  "is_working_on": false,
  "user_id": "coyote-162",
  "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": "2025-06-18T13:24:56-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": "2025-06-18T13:24:56-03:00",
  "start_date": "2025-06-18T13:24:56-03:00",
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 68",
  "client_id": 1,
  "project_name": "Test project 69",
  "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 80",
  "user_name": "Coyote 162",
  "guest_name": null,
  "board_name": "Board 90",
  "board_stage_name": "Board Stage 268",
  "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": "2025-06-18T13:24:56-03:00",
  "automation_id": null,
  "automation_name": null,
  "priority": null,
  "tag_list": "",
  "tags": [

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

  ]
}
POST

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

Reopen a Task

Reopen a closed task.

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

The task is eligible to be reopened if:

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

Parameters

Name Description type
id required

Task ID

integer
reopen_or_pause_descendant_tasks

Force pause/reopen all descendant tasks

boolean

Request

Route

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

Headers

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

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": 1,
  "title": "Bla 54",
  "is_working_on": false,
  "user_id": "coyote-168",
  "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": "2025-06-18T13:25:02-03:00",
  "queue_position": 1,
  "created_at": "2025-06-18T13:25:01-03:00",
  "start_date": "2025-06-18T13:25:02-03:00",
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 70",
  "client_id": 1,
  "project_name": "Test project 71",
  "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 82",
  "user_name": "Coyote 168",
  "guest_name": null,
  "board_name": "Board 92",
  "board_stage_name": "Board Stage 273",
  "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": "2025-06-18T13:25:02-03:00",
  "automation_id": null,
  "automation_name": null,
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 1,
  "responsible_id": "coyote-167",
  "task_state_id": 2,
  "responsible_name": "Coyote 167",
  "task_state_name": "Board Stage 273",
  "activities_7_days_ago": 0,
  "repetition_rule_id": null,
  "current_worked_time": 0,
  "estimated_delivery_date_updated": true,
  "last_estimated_at": "2025-06-18T13:25:02-03:00",
  "task_tags": [

  ],
  "approved": null,
  "task_status_id": 2,
  "task_status_name": "Board Stage 273",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-167",
      "team_id": null,
      "assignee_name": "Coyote 167",
      "team_name": null,
      "queue_position": 1,
      "priority": 1,
      "current_estimate_seconds": 3600,
      "time_worked": 0,
      "estimated_start_date": null,
      "estimate_updated": false,
      "start_date": "2025-06-18T13:25:02-03:00",
      "close_date": null,
      "is_closed": false,
      "reestimate_count": 0,
      "is_working_on": false,
      "automatic_time_worked_updated_at": "2025-06-18T13:25:01-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-74/coyote-167/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-74/coyote-167/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

200

Headers

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

Body

{
  "id": 4,
  "title": "Bla 63",
  "is_working_on": false,
  "user_id": "coyote-170",
  "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": "2025-06-18T13:25:07-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 79",
  "client_id": 4,
  "project_name": "Test project 80",
  "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 91",
  "user_name": "Coyote 170",
  "guest_name": null,
  "board_name": "Board 101",
  "board_stage_name": "Board Stage 299",
  "board_stage_description": null,
  "team_name": null,
  "type_color": "FFFFFF",
  "state": "queued",
  "overdue": null,
  "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": "2025-06-18T13:25:07-03:00",
  "automation_id": null,
  "automation_name": null,
  "priority": 2,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 4,
  "responsible_id": "coyote-170",
  "task_state_id": 10,
  "responsible_name": "Coyote 170",
  "task_state_name": "Board Stage 299",
  "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 299",
  "assignments": [
    {
      "id": "1254deb6e4",
      "task_id": 4,
      "assignee_id": "coyote-170",
      "team_id": null,
      "assignee_name": "Coyote 170",
      "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": "2025-06-18T13:25:07-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-77/coyote-170/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-77/coyote-170/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-173"
}

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": 1,
  "title": "Bla 65",
  "is_working_on": false,
  "user_id": "coyote-174",
  "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": "2025-06-18T13:25:10-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 81",
  "client_id": 1,
  "project_name": "Test project 82",
  "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 93",
  "user_name": "Coyote 174",
  "guest_name": null,
  "board_name": "Board 103",
  "board_stage_name": "Board Stage 305",
  "board_stage_description": null,
  "team_name": null,
  "type_color": "FFFFFF",
  "state": "queued",
  "overdue": null,
  "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": "2025-06-18T13:25:10-03:00",
  "automation_id": null,
  "automation_name": null,
  "priority": null,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 1,
  "responsible_id": "coyote-174",
  "task_state_id": 1,
  "responsible_name": "Coyote 174",
  "task_state_name": "Board Stage 305",
  "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 305",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-172",
      "team_id": null,
      "assignee_name": "Coyote 172",
      "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": "2025-06-18T13:25:10-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-79/coyote-172/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-79/coyote-172/regular.png",
      "time_worked_not_persisted": 0
    },
    {
      "id": "92a6f5b72",
      "task_id": 1,
      "assignee_id": "coyote-173",
      "team_id": null,
      "assignee_name": "Coyote 173",
      "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": "2025-06-18T13:25:10-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-79/coyote-173/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-79/coyote-173/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

200

Headers

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

Body

{
  "id": 1,
  "title": "Bla 68",
  "is_working_on": false,
  "user_id": "coyote-181",
  "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": "2025-06-18T13:25:15-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 84",
  "client_id": 1,
  "project_name": "Test project 85",
  "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 96",
  "user_name": "Coyote 181",
  "guest_name": null,
  "board_name": "Board 106",
  "board_stage_name": "Board Stage 314",
  "board_stage_description": null,
  "team_name": null,
  "type_color": "FFFFFF",
  "state": "queued",
  "overdue": null,
  "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": "2025-06-18T13:25:16-03:00",
  "automation_id": null,
  "automation_name": null,
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 1,
  "responsible_id": "coyote-180",
  "task_state_id": 1,
  "responsible_name": "Coyote 180",
  "task_state_name": "Board Stage 314",
  "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 314",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-180",
      "team_id": null,
      "assignee_name": "Coyote 180",
      "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": "2025-06-18T13:25:15-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-82/coyote-180/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-82/coyote-180/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

200

Headers

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

Body

{
  "id": 1,
  "title": "Bla 69",
  "is_working_on": false,
  "user_id": "coyote-183",
  "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": "2025-06-18T13:25: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 85",
  "client_id": 1,
  "project_name": "Test project 86",
  "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 97",
  "user_name": "Coyote 183",
  "guest_name": null,
  "board_name": "Board 107",
  "board_stage_name": "Board Stage 317",
  "board_stage_description": null,
  "team_name": null,
  "type_color": "FFFFFF",
  "state": "queued",
  "overdue": null,
  "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": "2025-06-18T13:25:19-03:00",
  "automation_id": null,
  "automation_name": null,
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 1,
  "responsible_id": "coyote-182",
  "task_state_id": 1,
  "responsible_name": "Coyote 182",
  "task_state_name": "Board Stage 317",
  "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 317",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-182",
      "team_id": null,
      "assignee_name": "Coyote 182",
      "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": "2025-06-18T13:25:18-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-83/coyote-182/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-83/coyote-182/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

200

Headers

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

Body

{
  "id": 1,
  "title": "Bla 74",
  "is_working_on": false,
  "user_id": "coyote-191",
  "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": "2025-06-18T13:25:25-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 90",
  "client_id": 1,
  "project_name": "Test project 91",
  "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 102",
  "user_name": "Coyote 191",
  "guest_name": null,
  "board_name": "Board 112",
  "board_stage_name": "Board Stage 332",
  "board_stage_description": null,
  "team_name": null,
  "type_color": "FFFFFF",
  "state": "queued",
  "overdue": null,
  "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": "2025-06-18T13:25:25-03:00",
  "automation_id": null,
  "automation_name": null,
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 1,
  "responsible_id": "coyote-193",
  "task_state_id": 1,
  "responsible_name": "Coyote 193",
  "task_state_name": "Board Stage 332",
  "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 332",
  "assignments": [
    {
      "id": "92a6f5b72",
      "task_id": 1,
      "assignee_id": "coyote-193",
      "team_id": null,
      "assignee_name": "Coyote 193",
      "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": "2025-06-18T13:25:25-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-86/coyote-193/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-86/coyote-193/regular.png",
      "time_worked_not_persisted": 0
    }
  ],
  "follower_ids": [

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

200

Headers

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

Body

{
  "id": 1,
  "title": "Bla 76",
  "is_working_on": false,
  "user_id": "coyote-200",
  "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": "2025-06-18T13:25:30-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 92",
  "client_id": 1,
  "project_name": "Test project 93",
  "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 104",
  "user_name": "Coyote 200",
  "guest_name": null,
  "board_name": "Board 114",
  "board_stage_name": "Board Stage 338",
  "board_stage_description": null,
  "team_name": "Test team 14",
  "type_color": "FFFFFF",
  "state": "queued",
  "overdue": null,
  "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": "2025-06-18T13:25:31-03:00",
  "automation_id": null,
  "automation_name": null,
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 1,
  "responsible_id": "coyote-199",
  "task_state_id": 1,
  "responsible_name": "Coyote 199",
  "task_state_name": "Board Stage 338",
  "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 338",
  "assignments": [
    {
      "id": "dbfa7092b",
      "task_id": 1,
      "assignee_id": "coyote-199",
      "team_id": 1,
      "assignee_name": "Coyote 199",
      "team_name": "Test team 14",
      "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": "2025-06-18T13:25:31-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-90/coyote-199/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-90/coyote-199/regular.png",
      "time_worked_not_persisted": 0
    }
  ],
  "follower_ids": [

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

200

Headers

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

Body

{
  "id": 1,
  "title": "Bla 82",
  "is_working_on": false,
  "user_id": "coyote-215",
  "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": "2025-06-18T13:25:43-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 98",
  "client_id": 1,
  "project_name": "Test project 99",
  "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 110",
  "user_name": "Coyote 215",
  "guest_name": null,
  "board_name": "Board 120",
  "board_stage_name": "Board Stage 356",
  "board_stage_description": null,
  "team_name": null,
  "type_color": "FFFFFF",
  "state": "queued",
  "overdue": null,
  "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": "2025-06-18T13:25:43-03:00",
  "automation_id": null,
  "automation_name": null,
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 1,
  "responsible_id": "coyote-214",
  "task_state_id": 1,
  "responsible_name": "Coyote 214",
  "task_state_name": "Board Stage 356",
  "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 356",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-214",
      "team_id": null,
      "assignee_name": "Coyote 214",
      "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": "2025-06-18T13:25:43-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-97/coyote-214/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-97/coyote-214/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

200

Headers

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

Body

{
  "id": 1,
  "title": "Bla 83",
  "is_working_on": false,
  "user_id": "coyote-217",
  "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": "2025-06-18T13:25: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 99",
  "client_id": 1,
  "project_name": "Test project 100",
  "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 111",
  "user_name": "Coyote 217",
  "guest_name": null,
  "board_name": "Board 121",
  "board_stage_name": "Board Stage 359",
  "board_stage_description": null,
  "team_name": null,
  "type_color": "FFFFFF",
  "state": "queued",
  "overdue": null,
  "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": "2025-06-18T13:25:45-03:00",
  "automation_id": null,
  "automation_name": null,
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 1,
  "responsible_id": "coyote-216",
  "task_state_id": 1,
  "responsible_name": "Coyote 216",
  "task_state_name": "Board Stage 359",
  "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 359",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-216",
      "team_id": null,
      "assignee_name": "Coyote 216",
      "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": "2025-06-18T13:25:45-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-98/coyote-216/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-98/coyote-216/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-219",
      "team_id": 1
    }
  ]
}

cURL

curl "https://runrun.it/api/v1.0/tasks/1/create_assignments" -d '{"assignments":[{"assignee_id":"coyote-219","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

200

Headers

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

Body

{
  "id": 1,
  "title": "Bla 84",
  "is_working_on": false,
  "user_id": "coyote-221",
  "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": "2025-06-18T13:25:47-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 100",
  "client_id": 1,
  "project_name": "Test project 101",
  "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 112",
  "user_name": "Coyote 221",
  "guest_name": null,
  "board_name": "Board 122",
  "board_stage_name": "Board Stage 362",
  "board_stage_description": null,
  "team_name": null,
  "type_color": "FFFFFF",
  "state": "queued",
  "overdue": null,
  "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": "2025-06-18T13:25:47-03:00",
  "automation_id": null,
  "automation_name": null,
  "priority": null,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 1,
  "responsible_id": "coyote-218",
  "task_state_id": 1,
  "responsible_name": "Coyote 218",
  "task_state_name": "Board Stage 362",
  "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 362",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-218",
      "team_id": null,
      "assignee_name": "Coyote 218",
      "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": "2025-06-18T13:25:47-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-99/coyote-218/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-99/coyote-218/regular.png",
      "time_worked_not_persisted": 0
    },
    {
      "id": "92a6f5b72",
      "task_id": 1,
      "assignee_id": "coyote-219",
      "team_id": 1,
      "assignee_name": "Coyote 219",
      "team_name": "Test team 15",
      "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": "2025-06-18T13:25:47-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-99/coyote-219/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-99/coyote-219/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

200

Headers

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

Body

{
  "id": 2,
  "title": "Bla 88",
  "is_working_on": false,
  "user_id": "coyote-232",
  "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": "2025-06-18T13:25: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 104",
  "client_id": 2,
  "project_name": "Test project 105",
  "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 116",
  "user_name": "Coyote 232",
  "guest_name": null,
  "board_name": "Board 127",
  "board_stage_name": "Board Stage 374",
  "board_stage_description": null,
  "team_name": null,
  "type_color": "FFFFFF",
  "state": "queued",
  "overdue": null,
  "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": "2025-06-18T13:25:56-03:00",
  "automation_id": null,
  "automation_name": null,
  "priority": 2,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 2,
  "responsible_id": "coyote-230",
  "task_state_id": 4,
  "responsible_name": "Coyote 230",
  "task_state_name": "Board Stage 374",
  "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 374",
  "assignments": [
    {
      "id": "92a6f5b72",
      "task_id": 2,
      "assignee_id": "coyote-230",
      "team_id": null,
      "assignee_name": "Coyote 230",
      "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": "2025-06-18T13:25:56-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-105/coyote-230/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-105/coyote-230/regular.png",
      "time_worked_not_persisted": 0
    }
  ],
  "follower_ids": [

  ]
}
POST

/api/v1.0/tasks/clone

Clone a task

Parameters

Name Description
from_task_id

From task

Request

Route

POST /api/v1.0/tasks/clone

Headers

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

Body

{
  "from_task_id": 1
}

cURL

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

Response

Simulated Response

Status

200

Headers

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

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

200

Headers

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

Body

{
  "id": 1,
  "title": "Bla 90",
  "is_working_on": false,
  "user_id": "coyote-236",
  "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": "2025-06-18T13:26:00-03:00",
  "queue_position": 1,
  "created_at": "2025-06-18T13:26: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 106",
  "client_id": 1,
  "project_name": "Test project 107",
  "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 118",
  "user_name": "Coyote 236",
  "guest_name": null,
  "board_name": "Board 129",
  "board_stage_name": "Board Stage 385",
  "board_stage_description": null,
  "team_name": null,
  "type_color": "FFFFFF",
  "state": "queued",
  "overdue": null,
  "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": "2025-06-18T13:26:00-03:00",
  "automation_id": null,
  "automation_name": null,
  "priority": 1,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 1,
  "responsible_id": "coyote-235",
  "task_state_id": 2,
  "responsible_name": "Coyote 235",
  "task_state_name": "Board Stage 385",
  "activities_7_days_ago": 0,
  "repetition_rule_id": null,
  "current_worked_time": 0,
  "estimated_delivery_date_updated": true,
  "last_estimated_at": "2025-06-18T13:26:00-03:00",
  "task_tags": [

  ],
  "approved": null,
  "task_status_id": 2,
  "task_status_name": "Board Stage 385",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-235",
      "team_id": null,
      "assignee_name": "Coyote 235",
      "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": "2025-06-18T13:26:00-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-107/coyote-235/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-107/coyote-235/regular.png",
      "time_worked_not_persisted": 0
    }
  ],
  "follower_ids": [

  ]
}
POST

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

Move a task to another stage

Parameters

Name Description type
id required

Task ID

integer
board_stage_id required

The id of the stage to move the task to

integer
board_stage_position

Optional position within the stage

integer
reopen_or_pause_descendant_tasks

Set to true to force reopen/pause descendant tasks if needed

Request

Route

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

Headers

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

Body

{
  "board_stage_id": 2
}

cURL

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

200

Headers

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

Body

{
  "id": 1,
  "title": "Bla 91",
  "is_working_on": false,
  "user_id": "coyote-238",
  "guest_id": null,
  "type_id": 1,
  "project_id": 1,
  "team_id": null,
  "board_id": 1,
  "board_stage_id": 2,
  "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": "2025-06-18T13:26:03-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": "2025-06-18T13:26:02-03:00",
  "start_date": "2025-06-18T13:26:03-03:00",
  "desired_start_date": null,
  "current_estimate_seconds": 3600,
  "evaluation_status": null,
  "attachments_count": 0,
  "tags_data": [

  ],
  "client_name": "Test client 107",
  "client_id": 1,
  "project_name": "Test project 108",
  "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 119",
  "user_name": "Coyote 238",
  "guest_name": null,
  "board_name": "Board 130",
  "board_stage_name": "Board Stage 388",
  "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": "2025-06-18T13:26:03-03:00",
  "automation_id": null,
  "automation_name": null,
  "priority": null,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 1,
  "responsible_id": "coyote-237",
  "task_state_id": 2,
  "responsible_name": "Coyote 237",
  "task_state_name": "Board Stage 388",
  "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": 2,
  "task_status_name": "Board Stage 388",
  "assignments": [
    {
      "id": "49537adb9",
      "task_id": 1,
      "assignee_id": "coyote-237",
      "team_id": null,
      "assignee_name": "Coyote 237",
      "team_name": null,
      "queue_position": null,
      "priority": null,
      "current_estimate_seconds": 3600,
      "time_worked": 0,
      "estimated_start_date": null,
      "estimate_updated": true,
      "start_date": "2025-06-18T13:26:03-03:00",
      "close_date": "2025-06-18T13:26:03-03:00",
      "is_closed": true,
      "reestimate_count": 0,
      "is_working_on": false,
      "automatic_time_worked_updated_at": "2025-06-18T13:26:02-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-108/coyote-237/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-108/coyote-237/regular.png",
      "time_worked_not_persisted": 0
    }
  ],
  "follower_ids": [

  ]
}
POST

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

Move with position

Parameters

Name Description type
id required

Task ID

integer
board_stage_id required

The id of the stage to move the task to

integer
board_stage_position

Optional position within the stage

integer
reopen_or_pause_descendant_tasks

Set to true to force reopen/pause descendant tasks if needed

Request

Route

POST /api/v1.0/tasks/3/move

Headers

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

Body

{
  "board_stage_id": 1,
  "board_stage_position": 1
}

cURL

curl "https://runrun.it/api/v1.0/tasks/3/move" -d '{"board_stage_id":1,"board_stage_position":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

200

Headers

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

Body

{
  "id": 3,
  "title": "Bla 94",
  "is_working_on": false,
  "user_id": "coyote-242",
  "guest_id": null,
  "type_id": 3,
  "project_id": 3,
  "team_id": null,
  "board_id": 1,
  "board_stage_id": 1,
  "board_stage_position": 1,
  "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": 3,
  "created_at": "2025-06-18T13:26:06-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 110",
  "client_id": 3,
  "project_name": "Test project 111",
  "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 122",
  "user_name": "Coyote 242",
  "guest_name": null,
  "board_name": "Board 131",
  "board_stage_name": "Board Stage 389",
  "board_stage_description": null,
  "team_name": null,
  "type_color": "FFFFFF",
  "state": "queued",
  "overdue": null,
  "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": "2025-06-18T13:26:06-03:00",
  "automation_id": null,
  "automation_name": null,
  "priority": 3,
  "tag_list": "",
  "tags": [

  ],
  "scheduled_start_time": null,
  "is_scheduled": false,
  "current_evaluator_id": null,
  "uid": 3,
  "responsible_id": "coyote-239",
  "task_state_id": 1,
  "responsible_name": "Coyote 239",
  "task_state_name": "Board Stage 389",
  "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 389",
  "assignments": [
    {
      "id": "dbfa7092b",
      "task_id": 3,
      "assignee_id": "coyote-239",
      "team_id": null,
      "assignee_name": "Coyote 239",
      "team_name": null,
      "queue_position": 3,
      "priority": 3,
      "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": "2025-06-18T13:26:06-03:00",
      "assignee_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-109/coyote-239/mini.png",
      "assignee_avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-109/coyote-239/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

Request

Route

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

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "form_answer": "<b>pergunta teste</b><br/>resposta teste<br/><br/>"
}
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

200

Headers

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

Body

[
  {
    "id": "custom_1",
    "label": "Nickname",
    "field_type": "short_text",
    "details": {
    },
    "description": null,
    "category": "custom",
    "boards_count": 1,
    "board_ids": [
      1
    ],
    "user_name": null,
    "last_editor_name": null,
    "created_at": "2025-06-05T12:30:53-03:00",
    "edited_at": null,
    "is_editable": false,
    "is_everyone_allowed_to_add_to_board": false,
    "integrators": [

    ],
    "status": "active",
    "position": null,
    "board_id": 1
  }
]

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

200

Headers

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

Body

[
  {
    "id": 1,
    "name": "Team 1",
    "leader_id": "coyote-337",
    "leader_name": "Coyote 337",
    "cost_center": null,
    "user_ids": [
      "coyote-337"
    ],
    "master_user_id": "coyote-337",
    "master_user_name": "Coyote 337"
  }
]
GET

/api/v1.0/teams/:id

Show a team

Request

Route

GET /api/v1.0/teams/1

Headers

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

cURL

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

200

Headers

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

Body

{
  "id": 1,
  "name": "Team 1",
  "leader_id": "coyote-340",
  "leader_name": "Coyote 340",
  "cost_center": null,
  "user_ids": [
    "coyote-340"
  ],
  "master_user_id": "coyote-340",
  "master_user_name": "Coyote 340"
}
POST

/api/v1.0/teams

Create a team

Parameters

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

Request

Route

POST /api/v1.0/teams

Headers

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

Body

{
  "team": {
    "name": "Team 1",
    "master_user_id": "coyote-341",
    "cost_center": "Cost center"
  }
}

cURL

curl "https://runrun.it/api/v1.0/teams" -d '{"team":{"name":"Team 1","master_user_id":"coyote-341","cost_center":"Cost center"}}' -X POST \
	-H "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

201

Headers

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

Body

{
  "id": 1,
  "name": "Team 1",
  "leader_id": "coyote-341",
  "leader_name": "Coyote 341",
  "cost_center": "Cost center",
  "user_ids": [
    "coyote-341"
  ],
  "master_user_id": "coyote-341",
  "master_user_name": "Coyote 341"
}
PUT

/api/v1.0/teams/:id

Update a team

Parameters

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

Request

Route

PUT /api/v1.0/teams/1

Headers

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

Body

{
  "team": {
    "name": "Team 2",
    "master_user_id": "coyote-343",
    "cost_center": "Cost center"
  }
}

cURL

curl "https://runrun.it/api/v1.0/teams/1" -d '{"team":{"name":"Team 2","master_user_id":"coyote-343","cost_center":"Cost center"}}' -X PUT \
	-H "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": 1,
  "name": "Team 2",
  "leader_id": "coyote-343",
  "leader_name": "Coyote 343",
  "cost_center": "Cost center",
  "user_ids": [
    "coyote-342",
    "coyote-343"
  ],
  "master_user_id": "coyote-343",
  "master_user_name": "Coyote 343"
}
DELETE

/api/v1.0/teams/:id

Destroy a team

Request

Route

DELETE /api/v1.0/teams/1

Headers

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

cURL

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

Response

Simulated Response

Status

204

Headers

POST

/api/v1.0/teams/:id/add_member

Add a user to a team

Parameters

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

Request

Route

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

Headers

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

Body

{
  "user_id": "coyote-347"
}

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": 1,
  "name": "Team 1",
  "leader_id": "coyote-346",
  "leader_name": "Coyote 346",
  "cost_center": null,
  "user_ids": [
    "coyote-346",
    "coyote-347"
  ],
  "master_user_id": "coyote-346",
  "master_user_name": "Coyote 346"
}
POST

/api/v1.0/teams/:id/remove_member

Remove a user from team

Parameters

Name Description type
user_id required

Team member id

string

Request

Route

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

Headers

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

Body

{
  "user_id": "coyote-349"
}

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": 1,
  "name": "Team 1",
  "leader_id": "coyote-348",
  "leader_name": "Coyote 348",
  "cost_center": null,
  "user_ids": [
    "coyote-348"
  ],
  "master_user_id": "coyote-348",
  "master_user_name": "Coyote 348"
}

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

200

Headers

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

Body

{
  "meta": {
    "period_start": "2018-01-31",
    "period_end": "2018-02-06",
    "unit": "day"
  },
  "result": [
    {
      "date": "2018-02-05",
      "project_id": 1,
      "project_name": "Test project 353",
      "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 352",
      "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

200

Headers

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

Body

[
  {
    "id": "coyote-120",
    "name": "Coyote 120",
    "email": "coyote120@acme.foo",
    "avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-116/coyote-120/mini.png",
    "avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-116/coyote-120/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": "2025-06-18T13:25:23-03:00",
    "in_company_since": null,
    "is_certified": false,
    "is_certified_expert": false,
    "language": "en-US",
    "alt_id": "bedaa6220a98cb3eb38815f9aeacc7c2",
    "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-119",
    "name": "Coyote 119",
    "email": "coyote119@acme.foo",
    "avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-116/coyote-119/mini.png",
    "avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-116/coyote-119/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": "2025-06-18T13:25:22-03:00",
    "in_company_since": null,
    "is_certified": false,
    "is_certified_expert": false,
    "language": "en-US",
    "alt_id": "80a4d03a048afe125ca3090c7ed4bb61",
    "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

Get a user by id

Parameters

Name Description type
user_id required

User's ID

string

Request

Route

GET /api/v1.0/users/coyote-145

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-145" -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

200

Headers

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

Body

{
  "id": "coyote-145",
  "name": "Coyote 145",
  "email": "coyote145@acme.foo",
  "avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-123/coyote-145/mini.png",
  "avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-123/coyote-145/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": "2025-06-18T13:25:37-03:00",
  "in_company_since": null,
  "is_certified": false,
  "is_certified_expert": false,
  "language": "en-US",
  "alt_id": "d8dd8324a5561e2f84fe91b5d59855ff",
  "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

201

Headers

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

Body

{
  "id": "jon-smith",
  "name": "Jon Smith",
  "email": "john@smith.com",
  "avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-124/jon-smith/351227d5be16471a8e3ac93cca169784mini.png",
  "avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-124/jon-smith/351227d5be16471a8e3ac93cca169784regular.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": "2025-06-18T13:25:39-03:00",
  "in_company_since": null,
  "is_certified": false,
  "is_certified_expert": false,
  "language": "en-GB",
  "alt_id": "fe95008f5bd1a17b7f218a000462b772",
  "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

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

200

Headers

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

Body

{
  "id": "jon-smith",
  "name": "Steve Jobs",
  "email": "coyote160@acme.foo",
  "avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-133/jon-smith/mini.png",
  "avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-133/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
  }
}

UsersVacations

GET

/api/v1.0/users_vacations

Get user vacations

Request

Route

GET /api/v1.0/users_vacations

Headers

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

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

[
  {
    "id": 1,
    "user_id": "coyote-652",
    "period_start": "2021-10-05",
    "period_end": "2021-11-20"
  }
]
POST

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

Create an user vacation

Request

Route

POST /api/v1.0/users/coyote-654/vacations

Headers

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

Body

{
  "user_vacation": {
    "period_start": "2021-11-01",
    "period_end": "2021-12-01"
  }
}

cURL

curl "https://runrun.it/api/v1.0/users/coyote-654/vacations" -d '{"user_vacation":{"period_start":"2021-11-01","period_end":"2021-12-01"}}' -X POST \
	-H "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

201

Headers

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

Body

{
  "id": 1,
  "user_id": "coyote-654",
  "period_start": "2021-11-01",
  "period_end": "2021-12-01"
}
GET

/api/v1.0/users_vacations/:id

Show an user vacation

Request

Route

GET /api/v1.0/users_vacations/1

Headers

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

cURL

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

200

Headers

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

Body

{
  "id": 1,
  "user_id": "coyote-656",
  "period_start": "2021-10-05",
  "period_end": "2021-11-20"
}
PUT

/api/v1.0/users_vacations/:id

Update an user vacation

Request

Route

PUT /api/v1.0/users_vacations/1

Headers

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

Body

{
  "user_vacation": {
    "period_start": "2021-11-01",
    "period_end": "2021-12-01"
  }
}

cURL

curl "https://runrun.it/api/v1.0/users_vacations/1" -d '{"user_vacation":{"period_start":"2021-11-01","period_end":"2021-12-01"}}' -X PUT \
	-H "Version: HTTP/1.0" \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": 1,
  "user_id": "coyote-658",
  "period_start": "2021-11-01",
  "period_end": "2021-12-01"
}
DELETE

/api/v1.0/users_vacations/:id

Destroy an user vacation

Request

Route

DELETE /api/v1.0/users_vacations/1

Headers

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

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": 1,
  "user_id": "coyote-660",
  "period_start": "2021-10-05",
  "period_end": "2021-11-20"
}

Workflow Elements

GET

/api/v1.0/workflows/:workflow_id/workflow_elements

List workflow elements

Parameters

Name Description type
workflow_id required

ID of workflow

integer

Request

Route

GET /api/v1.0/workflows/1/workflow_elements

Headers

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

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

[
  {
    "id": 1,
    "workflow_id": 1,
    "order": 1,
    "is_current": true,
    "is_completed": false,
    "current": true,
    "completed": false,
    "completed_at": null,
    "started_at": "2025-06-18T13:30:04-03:00",
    "user_id": "coyote-400",
    "user_name": "Coyote 400",
    "user_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-266/coyote-400/mini.png",
    "team_id": null,
    "team_name": null
  },
  {
    "id": 2,
    "workflow_id": 1,
    "order": 1,
    "is_current": false,
    "is_completed": false,
    "current": false,
    "completed": false,
    "completed_at": null,
    "started_at": null,
    "user_id": "coyote-401",
    "user_name": "Coyote 401",
    "user_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-266/coyote-401/mini.png",
    "team_id": 1,
    "team_name": "Test team 10"
  }
]
GET

/api/v1.0/workflows/:workflow_id/workflow_elements/:id

Show a workflow element

Parameters

Name Description type
id required

ID of workflow element

integer
workflow_id required

ID of workflow

integer

Request

Route

GET /api/v1.0/workflows/1/workflow_elements/2

Headers

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

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": 2,
  "workflow_id": 1,
  "order": 2,
  "is_current": false,
  "is_completed": false,
  "current": false,
  "completed": false,
  "completed_at": null,
  "started_at": null,
  "user_id": "coyote-405",
  "user_name": "Coyote 405",
  "user_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-268/coyote-405/mini.png",
  "team_id": 1,
  "team_name": "Test team 11"
}
POST

/api/v1.0/workflows/:workflow_id/workflow_elements

Create a workflow element

Parameters

Name Description type
workflow_id required

ID of workflow

integer
user_id required

User ID

string
team_id

Team ID of the user

integer
order

Order of the element on workflow

integer

Request

Route

POST /api/v1.0/workflows/1/workflow_elements

Headers

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

Body

{
  "workflow_element": {
    "user_id": "coyote-409",
    "team_id": 1,
    "order": 2
  }
}

cURL

curl "https://runrun.it/api/v1.0/workflows/1/workflow_elements" -d '{"workflow_element":{"user_id":"coyote-409","team_id":1,"order":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

201

Headers

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

Body

{
  "id": 2,
  "workflow_id": 1,
  "order": 2,
  "is_current": false,
  "is_completed": false,
  "current": false,
  "completed": false,
  "completed_at": null,
  "started_at": null,
  "user_id": "coyote-409",
  "user_name": "Coyote 409",
  "user_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-270/coyote-409/mini.png",
  "team_id": 1,
  "team_name": "Test team 12"
}
POST

/api/v1.0/workflows/:workflow_id/workflow_elements/:id/reorder

Reorder a workflow element

Parameters

Name Description type
id required

ID of workflow element

integer
workflow_id required

ID of workflow

integer
order

Order of the element on workflow

integer

Request

Route

POST /api/v1.0/workflows/1/workflow_elements/3/reorder

Headers

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

Body

{
  "order": 2
}

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": 3,
  "workflow_id": 1,
  "order": 2,
  "is_current": false,
  "is_completed": false,
  "current": false,
  "completed": false,
  "completed_at": null,
  "started_at": null,
  "user_id": "coyote-416",
  "user_name": "Coyote 416",
  "user_avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-272/coyote-416/mini.png",
  "team_id": 1,
  "team_name": "Test team 13"
}
DELETE

/api/v1.0/workflows/:workflow_id/workflow_elements/:id

Destroy a workflow element

Parameters

Name Description type
id required

ID of workflow element

integer
workflow_id required

ID of workflow

integer

Request

Route

DELETE /api/v1.0/workflows/1/workflow_elements/2

Headers

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

cURL

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

Response

Simulated Response

Status

204

Headers

Workflows

GET

/api/v1.0/workflows

Show a task workflow

Parameters

Name Description
task_id required

ID of the task the workflow belongs to

Request

Route

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

Headers

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

Query Parameters

task_id=1

cURL

curl -g "https://runrun.it/api/v1.0/workflows?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

200

Headers

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

Body

{
  "id": 1,
  "workable_id": 1,
  "workable_type": "Task",
  "task_id": 1,
  "current_workflow_element_id": 1,
  "is_last_element": true,
  "is_first_element": true
}
POST

/api/v1.0/workflows

Create a task workflow

Parameters

Name Description
task_id required

ID of the task the workflow will be associated

Request

Route

POST /api/v1.0/workflows

Headers

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

Body

{
  "task_id": 1,
  "workflow": {
  }
}

cURL

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

Response

Simulated Response

Status

201

Headers

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

Body

{
  "id": 1,
  "workable_id": 1,
  "workable_type": "Task",
  "task_id": 1,
  "current_workflow_element_id": 1,
  "is_last_element": true,
  "is_first_element": true
}
DELETE

/api/v1.0/workflows

Destroy task workflow

Parameters

Name Description
task_id required

ID of the task the workflow belongs to

Request

Route

DELETE /api/v1.0/workflows

Headers

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

Body

{
  "task_id": 1
}

cURL

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

Response

Simulated Response

Status

204

Headers

GET

/api/v1.0/workflows

Show a task_template workflow

Parameters

Name Description
task_template_id required

ID of the task_template the workflow belongs to

Request

Route

GET /api/v1.0/workflows?task_template_id=5

Headers

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

Query Parameters

task_template_id=5

cURL

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": 1,
  "workable_id": 5,
  "workable_type": "TaskTemplate",
  "task_template_id": 5,
  "current_workflow_element_id": null,
  "is_last_element": true,
  "is_first_element": true
}
POST

/api/v1.0/workflows

Create a task_template workflow

Parameters

Name Description
task_template_id required

ID of the task_template the workflow will be associated

Request

Route

POST /api/v1.0/workflows

Headers

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

Body

{
  "task_template_id": 6,
  "workflow": {
  }
}

cURL

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

Response

Simulated Response

Status

201

Headers

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

Body

{
  "id": 1,
  "workable_id": 6,
  "workable_type": "TaskTemplate",
  "task_template_id": 6,
  "current_workflow_element_id": null,
  "is_last_element": true,
  "is_first_element": true
}
DELETE

/api/v1.0/workflows

Destroy task_template workflow

Parameters

Name Description
task_template_id required

ID of the task_template the workflow belongs to

Request

Route

DELETE /api/v1.0/workflows

Headers

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

Body

{
  "task_template_id": 7
}

cURL

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

Response

Simulated Response

Status

204

Headers