API Reference/Tasks

Tasks

For authentication instructions, see API overview.

Endpoints

get/api/v2/tasks

post/api/v2/tasks

get/api/v2/tasks/:id

put/api/v2/tasks/:id

patch/api/v2/tasks/:id

delete/api/v2/tasks/:id

get

List all task

Returns a list of task. The task are returned in sorted order, with the most recent appearing first.

Query parameters

limitinteger
The number of records to return
pageinteger
The page number
orderstring
The order of the records
sortBystring
The sort of the records
fieldsstring
The filter of the records
pstring
policyFilters
qstring
search query

Request

cURL

export ICLOUDREADY_API_KEY=[your api key]
curl \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/tasks

Response

No response schema

post

Create task

Create task. You need to pass through any required fields, and you can optionally pass through other fields.

Request body

namestring
typestring
descriptionstring
dueTimestring
assignedToAccountstring
sourcestring
externalIdstring
parentIdstring

Request

cURL

export ICLOUDREADY_API_KEY=[your api key]
curl -X POST -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/tasks \
	-d 'name="task1"' \
	-d 'type="type1"' \
	-d 'description="test tasks"' \
	-d 'dueTime="15/01/2023"' \
	-d 'assignedToAccount="609a8f85c2834915d0a5a5e8"' \
	-d 'source="string"' \
	-d 'externalId="string"' \
	-d 'parentId="string"'

Response

No response schema

get

Retrieve task

Returns a single tas, which you can request by passing through an id in the url.

Path parameters

idstring
ID of the task

Request

cURL

export ICLOUDREADY_API_KEY=[your api key]
curl \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/tasks/:id

Response

No response schema

put

Update task

Path parameters

idstring
ID of the task

Request

cURL

export ICLOUDREADY_API_KEY=[your api key]
curl -X PUT \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/tasks/:id

Response

No response schema

patch

Update task soft

Update task soft by setting the values of the parameters passed. Any parameters not set will be unchanged.

Path parameters

idstring
ID of the task

Request

cURL

export ICLOUDREADY_API_KEY=[your api key]
curl \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/tasks/:id

Response

No response schema

delete

Delete task

Path parameters

idstring
ID of the task

Request

cURL

export ICLOUDREADY_API_KEY=[your api key]
curl -X DELETE \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/tasks/:id

Response

No response schema