EVeverhour
Tasks

Search Project Tasks

Changed on

Search tasks within a single project. Same query semantics as GET /tasks/search; limit must be between 1 and 100.

get/projects/{project_id}/tasks/search

Request

Path parameters

project_idstring required
Example:ev:1234567789001

Project ID

Query parameters

querystring
Example:Managem

Search query

limitinteger
Example:10

Max number of search results

searchInClosedboolean

Should we search in closed/completed tasks?

searchInUnscheduledboolean

Return unscheduled tasks (not in any section). Works without a query.

Response

OK

idstring required
namestring required
typestring

Object kind reported by the source platform.

urlstring

Link to the task in the source platform. Absent for native Everhour tasks.

numberstring

Issue number or key in the source platform. Absent for native Everhour tasks.

projectsstring[] required

List of projects ID

sectionnumber nullable

Section ID

labelsstring[]
positionnumber
descriptionstring nullable
dueAtstring nullable

Format: Y-m-d H:i:s

dueOnstring nullable

Due date without a time component. Format: Y-m-d

status'open' | 'completed' | 'closed'
completedboolean

Mirrors status — true when the task is done in the source platform.

completedAtstring nullable

When the task was completed. Format: Y-m-d H:i:s

createdAtstring

Format: Y-m-d H:i:s

createdBynumber

ID of the user who created the task. Native Everhour tasks only.

favoriteboolean

Whether you marked this task as a favorite.

iterationstring

Sprint, board column, or section the task sits in, as reported by the source platform.

colorstring

Task color as a hex value. Native Everhour tasks only.

commentsnumber

Number of comments on the task.

attributesobject

Custom attributes from integration

metricsobject

Custom metrics from integration

unbillableboolean

true when the task is marked as non-billable.

Example response

[
  {
    "id": "ev:9876543210",
    "name": "Task Name",
    "type": "task",
    "url": "https://github.com/acme/web/issues/8688",
    "number": "ED-774",
    "projects": [
      "ev:1234567890"
    ],
    "section": 1234,
    "labels": [
      "high",
      "bug"
    ],
    "position": 1,
    "dueAt": "2018-03-05 16:00:00",
    "dueOn": "2024-10-31",
    "status": "open",
    "completedAt": "2024-01-24 14:36:20",
    "createdAt": "2023-04-07 13:11:20",
    "createdBy": 1304,
    "assignees": [
      {
        "userId": 1304,
        "accountId": "gh:313991",
        "accountName": "jbender"
      }
    ],
    "iteration": "In Progress",
    "color": "#edacc7",
    "comments": 1,
    "time": {
      "total": 7200,
      "users": {
        "1304": 3600,
        "1543": 3600
      },
      "timerTime": 5400
    },
    "estimate": {
      "total": 7200,
      "type": "overall",
      "users": {
        "1304": 3600,
        "1543": 3600
      }
    },
    "attributes": {
      "Client": "Everhour",
      "Priority": "high"
    },
    "metrics": {
      "efforts": 42,
      "expenses": 199
    }
  }
]

Changes

  • 92850a5e60d1Revision changes
    • warning

      added the new completed enum value to the / response property for the response status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status