⚑
Other integrations
πŸ’Ÿ
Account health scores & metrics
Tasks

The Task object

Property
Description
Editable
id
Vitally's unique ID for the Task
No
createdAt
Datetime the Task was created
No
updatedAt
Datetime the Task was last updated
No
externalId
​Your unique ID for the Task
Only on create
accountId
Required The ID of the Vitally Account the Task is for
Yes
name
Required The subject or title of the Task
Yes
description
The body of the Task, may include HTML (see HTML Fields)
Yes
dueDate
The date-time of when the Task is due
Yes
assignedToId
The ID of the Vitally Admin who is assigned to the Task
Yes
completedById
The ID of the Vitally Admin who completed to the Task
Yes
categoryId
The ID of the Vitally Note Category the Note belongs to
Yes
projects
An array of project IDs and names { id, name }[]
In-app

The Task Category object

Property
Description
Editable
id
Vitally's unique ID for the Message
No
createdAt
Datetime the Note was created
No
updatedAt
Datetime the Note was last updated
No
name
The name of the Note Category
In-app

List Tasks GET

1
https://rest.vitally.io/resources/tasks
Copied!
Paginated list of Tasks, by default ordered by updatedAt.
Query Params (see Pagination)
Param
Type
Description
limit
number
(optional) The number of items to return. The max/default is 100
from
string
(optional) The cursor returned from a previous request
Params (see Pagination)
1
GET https://rest.vitally.io/resources/tasks?limit=10&from=cursor
Copied!
Example Response
1
{
2
"results": [
3
{
4
"externalId": "task-1",
5
"name": "Check in on the Account",
6
"description": "<p>Be sure to ask how onboarding is going.</p>",
7
"createdAt": "2020-12-11T20:16:27.370Z",
8
"updatedAt": "2020-12-11T20:16:27.370Z",
9
"createdById": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
10
"assignedToId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
11
"completedById": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
12
"dueDate": "2021-01-01",
13
"completedAt": "2020-12-29T20:16:27.370Z",
14
}
15
],
16
"next": "c29tZWJhc2U2NA=="
17
}
Copied!

List Tasks For An Account GET

1
https://rest.vitally.io/resources/accounts/:accountId/tasks
Copied!
Paginated list of Tasks for a given Account, by default ordered by updatedAt.
Request Params
Property
Type
Description
id
string
The Task ID assigned by Vitally
Query Params (see Pagination)
Example Request
1
GET https://rest.vitally.io/resources/accounts/:accountId/tasks?limit=10&from=cursor
Copied!
Example Response
1
{
2
"results": [
3
{
4
"externalId": "task-1",
5
"name": "Check in on the Account",
6
"description": "<p>Be sure to ask how onboarding is going.</p>",
7
"createdAt": "2020-12-11T20:16:27.370Z",
8
"updatedAt": "2020-12-11T20:16:27.370Z",
9
"createdById": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
10
"assignedToId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
11
"completedById": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
12
"dueDate": "2021-01-01",
13
"completedAt": "2020-12-29T20:16:27.370Z",
14
}
15
],
16
"next": "c29tZWJhc2U2NA=="
17
}
Copied!

Create A Task POST

1
https://rest.vitally.io/resources/tasks
Copied!
Task's are unique on externalId. So creating and updating are both possible via the POST endpoint.
Request Body
Property
Type
Description
name
string
Required The name or subject of the Task
accountId
string
Required The ID of the Vitally Account to associate the Task with
externalId
string
The unique ID of the Task in your system
description
string
The description of the Task, may include HTML (see HTML Fields)
assignedToId
string
The ID of the Vitally Admin User who is assigned to the Task
completedById
string
The ID of the Vitally Admin User who completed to the Task
dueDate
string
The date when the Task is due
completedAt
string
The timestamp of when the Task was completed
categoryId
string
The Vitally ID of the Task Category
Example Request
1
POST https://rest.vitally.io/resources/tasks
2
{
3
"name": "Check in on the Account",
4
"accountId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
5
"externalId": "task-1",
6
"description": "<p>Be sure to ask how onboarding is going.</p>",
7
"assignedToId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
8
"completedById": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
9
"dueDate": "2021-01-01",
10
"completedAt": "2020-12-29T20:16:27.370Z"
11
}
Copied!
Example Response
1
{
2
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
3
"externalId": "task-1",
4
"accountId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
5
"categoryId": null,
6
"assignedToId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
7
"completedById": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
8
"name": "Check in on the Account",
9
"description": "<p>Be sure to ask how onboarding is going.</p>",
10
"dueDate": "2021-01-01",
11
"completedAt": "2020-12-29T20:16:27.370Z"
12
}
Copied!

Get A Task GET

1
https://rest.vitally.io/resources/tasks/:id
Copied!
Request Params
Property
Type
Description
id
string
The Task ID assigned by Vitally

Update A Task PUT

1
https://rest.vitally.io/resources/task/:id
Copied!
Request Params
Property
Type
Description
id
string
Accepts both the Task ID assigned by Vitally and the externalId if provided when creating the Task
Request Body
Property
Type
Description
name
string
The name or subject of the Task
accountId
string
The ID of the Vitally Account to associate the Task with
externalId
string
The unique ID of the Task in your system
description
string
The description of the Task, may include HTML (see HTML Fields)
assignedToId
string
The ID of the Vitally Admin User who is assigned to the Task
completedById
string
The ID of the Vitally Admin User who completed to the Task
dueDate
string
The date when the Task is due
completedAt
string
The timestamp of when the Task was completed
categoryId
string
The Vitally ID of the Task Category

Delete A Task `DELETE

1
https://rest.vitally.io/resources/tasks/:id
Copied!
Request Params
Property
Type
Description
id
string
The Task ID assigned by Vitally

List A Task Categories GET

1
https://rest.vitally.io/resources/taskCategories
Copied!
Paginated list of Task Categories.
Task Categories are managed in the Vitally UI. The ID of the Task Category is required for associating a Task with a Task Category via the Rest API.
Params (see Pagination)
Query Params
Param
Type
Description
limit
number
(optional) The number of items to return. The max/default is 100
from
string
(optional) The cursor returned from a previous request
Example Request
1
GET https://rest.vitally.io/resources/taskCategories?limit=10&from=cursor
Copied!
Example Response
1
{
2
"results": [
3
{
4
"id": "xxxx-xxxxx-xxxxxxxx-xxxxxxxx",
5
"name": "Onboarding",
6
"createdAt": "2020-12-11T20:16:27.370Z",
7
"updatedAt": "2020-12-11T20:16:27.370Z"
8
},
9
{
10
"id": "xxxx-xxxxx-xxxxxxxx-xxxxxxxx",
11
"name": "High Touch",
12
"createdAt": "2020-12-11T20:16:27.370Z",
13
"updatedAt": "2020-12-11T20:16:27.370Z"
14
}
15
],
16
"next": "c29tZWJhc2U2NA=="
17
}
Copied!
Last modified 5mo ago