Lists a project's tasks. - Gorelo Documentation

GET

projects

{projectId}

tasks

Lists a project's tasks.

curl --request GET \
  --url https://api.usw.gorelo.io/v1/projects/{projectId}/tasks \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.usw.gorelo.io/v1/projects/{projectId}/tasks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.usw.gorelo.io/v1/projects/{projectId}/tasks",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.usw.gorelo.io/v1/projects/{projectId}/tasks"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.usw.gorelo.io/v1/projects/{projectId}/tasks")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": [
    {
      "Id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "Title": "<string>",
      "Number": 123,
      "DisplayNumber": "<string>",
      "SectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "LeadAssigneeId": 123,
      "AssistingAssigneeIds": [
        123
      ],
      "WatcherIds": [
        123
      ],
      "PrimaryGroupId": 123,
      "Status": {
        "Id": 1,
        "Name": "<string>"
      },
      "StatusUpdatedOn": "2023-11-07T05:31:56Z",
      "StatusReason": "<string>",
      "Priority": {
        "Id": 1,
        "Name": "<string>"
      },
      "DueDate": "2023-11-07T05:31:56Z",
      "ChecklistSummary": {
        "Completed": 123,
        "Total": 123,
        "ProgressPercent": 123
      },
      "IsUnread": true,
      "IsWaitingOnThem": true,
      "BlockedByTaskIds": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "BlockingTaskIds": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "LastUpdate": {
        "UpdateType": "<string>",
        "Summary": "<string>",
        "On": "2023-11-07T05:31:56Z"
      },
      "CreatedOn": "2023-11-07T05:31:56Z",
      "UpdatedOn": "2023-11-07T05:31:56Z",
      "ClosedOn": "2023-11-07T05:31:56Z"
    }
  ],
  "DataContext": {
    "Pagination": {
      "NextCursor": "<string>",
      "PreviousCursor": "<string>",
      "HasMore": true,
      "HasPrevious": true,
      "TotalCount": 123
    }
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

Authorizations

X-API-Key

string

header

required

Your Gorelo API key. See Generate API key. If your data is hosted in Australia, click the base URL at the top of this page and select https://api.aue.gorelo.io.

Path Parameters

projectId

string<uuid>

required

Project whose tasks to list.

Query Parameters

Cursor

string

Opaque pagination cursor from a previous page; omit for the first page.

PageSize

integer<int32>

default:50

Number of items per page, 1-200 (default 50). Out of range is rejected, not clamped.

SortBy

string

default:boardOrder

Sort field: boardOrder (default), createdOn or updatedOn.

SortOrder

string

default:asc

Sort direction: asc (default) or desc.

SectionIds

string

Comma-separated section ids (Guids).

StatusIds

string

Comma-separated task status ids: 1 Not started, 2 Working on it, 3 On hold, 4 Done. Any other id is a 400. Omitted returns every status.

AssigneeIds

string

Comma-separated technician ids; matches a task's lead or assisting assignees.

LeadAssigneeIds

string

Comma-separated technician ids; matches a task's lead assignee only.

IncompleteOnly

boolean

default:false

When true, drops tasks in the Done status.

DueAfter

string<date-time>

Keeps only tasks due at or after this instant (UTC). A task with no due date matches neither bound.

DueBefore

string<date-time>

Keeps only tasks due strictly before this instant (UTC).

Response

StatusCode

enum<integer>

Available options:

100,

101,

102,

103,

200,

201,

202,

203,

204,

205,

206,

207,

208,

226,

300,

301,

302,

303,

304,

305,

306,

307,

308,

400,

401,

402,

403,

404,

405,

406,

407,

408,

409,

410,

411,

412,

413,

414,

415,

416,

417,

421,

422,

423,

424,

426,

428,

429,

431,

451,

500,

501,

502,

503,

504,

505,

506,

507,

508,

510,

511

IsSuccess

boolean

Data

object[] | null

Show child attributes

DataContext

object

The DataContext of a cursor-paginated success response: carries the paging metadata for the returned page.

Show child attributes

Notifications

object[]

Show child attributes

⌘I

Lists a project's tasks.

curl --request GET \
  --url https://api.usw.gorelo.io/v1/projects/{projectId}/tasks \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.usw.gorelo.io/v1/projects/{projectId}/tasks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.usw.gorelo.io/v1/projects/{projectId}/tasks",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.usw.gorelo.io/v1/projects/{projectId}/tasks"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.usw.gorelo.io/v1/projects/{projectId}/tasks")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": [
    {
      "Id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "Title": "<string>",
      "Number": 123,
      "DisplayNumber": "<string>",
      "SectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "LeadAssigneeId": 123,
      "AssistingAssigneeIds": [
        123
      ],
      "WatcherIds": [
        123
      ],
      "PrimaryGroupId": 123,
      "Status": {
        "Id": 1,
        "Name": "<string>"
      },
      "StatusUpdatedOn": "2023-11-07T05:31:56Z",
      "StatusReason": "<string>",
      "Priority": {
        "Id": 1,
        "Name": "<string>"
      },
      "DueDate": "2023-11-07T05:31:56Z",
      "ChecklistSummary": {
        "Completed": 123,
        "Total": 123,
        "ProgressPercent": 123
      },
      "IsUnread": true,
      "IsWaitingOnThem": true,
      "BlockedByTaskIds": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "BlockingTaskIds": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "LastUpdate": {
        "UpdateType": "<string>",
        "Summary": "<string>",
        "On": "2023-11-07T05:31:56Z"
      },
      "CreatedOn": "2023-11-07T05:31:56Z",
      "UpdatedOn": "2023-11-07T05:31:56Z",
      "ClosedOn": "2023-11-07T05:31:56Z"
    }
  ],
  "DataContext": {
    "Pagination": {
      "NextCursor": "<string>",
      "PreviousCursor": "<string>",
      "HasMore": true,
      "HasPrevious": true,
      "TotalCount": 123
    }
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}