REST API: Project Templates

Replace {subdomain} in the endpoints below with your Vitally subdomain.

You can find your subdomain in the URL used to log into Vitally (i.e., https://yoursubdomain.vitally.io

The Project Template Response object

Property	Description	Editable
id	Vitally's unique ID for the Project Template	No
createdAt	Datetime the Project Template was created	No
updatedAt	Datetime the Project Template was last updated	No
name	The title of the Project Template	No
projectName	The Project name that the Project Template will create	No
description	The description of the Project Template	No
projectCategoryId	The Project Category the Project Template is related to	No
traits	A key-value JSON object of custom project traits. See below for more details.	Yes

The Project Category Response object

Property	Description	Editable
id	Vitally's unique ID for the Project Category	No
createdAt	Datetime the Project Category was created	No
updatedAt	Datetime the Project Category was last updated	No
name	The title of the Project Category	No

The Project Response object

Property	Description	Editable
id	Vitally's unique ID for the Project	No
name	The title of the Project	No

Project custom traits

In Vitally, if you are an admin, you can add additional fields to your tasks via the Traits management section. When you create a trait, we will provide you with a key for that trait:

Using this key, you can set values for this trait when POSTing to the API:

Example Request

POST https://{subdomain}.rest.vitally.io/resources/projects
{
  "templateId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "organizationId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "traits": {
    "vitally.custom.nextStep": "Give em a call!"
  }
}

Note that when updating traits, if a trait is not specified, it will not be deleted from the project (i.e. the value for the trait will remain unchanged). To actually delete a trait from a project, simply specify the trait with a null value.

List Project Templates GET

US Data Center (default):

https://{subdomain}.rest.vitally.io/resources/projectTemplates

EU Data Center:

https://rest.vitally-eu.io/resources/projectTemplates

Paginated list of Project Templates ordered by updatedAt

Query Params (see Pagination)

Param	Type	Description
categoryId	string	The unique ID of the Project Category to filter for

Example Request

GET https://{subdomain}.rest.vitally.io/resources/projectTemplates?categoryId=1&limit=1

Example Response

{
  "results": [
    {
      "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "createdAt": "2022-02-O2T22:22:22.222Z",
      "updatedAt": "2022-02-O2T22:22:22.222Z",
      "name": "Onboarding - Enterprise",
      "projectName": "Onboarding",
      "projectCategoryId": "1"
    }
  ],
  "next": "c29tZWJhc2U2NA=="
}

List Project Categories GET

US Data Center (default):

https://{subdomain}.rest.vitally.io/resources/projectCategories

EU Data Center:

https://rest.vitally-eu.io/resources/projectCategories

Paginated list of Project Templates ordered by updatedAt

Query Params (see Pagination)

Example Request

GET https://{subdomain}.rest.vitally.io/resources/projectCategories?limit=1

Example Response

{
  "results": [
    {
      "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "createdAt": "2022-02-O2T22:22:22.222Z",
      "updatedAt": "2022-02-O2T22:22:22.222Z",
      "name": "Onboarding"
    }
  ],
  "next": "c29tZWJhc2U2NA=="
}

Create A Project Using A Template POST

US Data Center (default):

https://{subdomain}.rest.vitally.io/resources/projects

EU Data Center:

https://rest.vitally-eu.io/resources/projects

Request Body

Property	Type	Description
templateId	string	Required The ID of the Project Template. See List Project Templates endpoint above.
customerId	string	Required* The ID of the Account to add the project to. Should not be provided if providing organizationId
organizationId	string	Required* The ID of the Organization to add the project to. Should not be provided if providing customerId
traits	key/value object	A key-value JSON object of custom project traits. See Project custom traits above for more details.

Example

POST https://{subdomain}.rest.vitally.io/resources/projects
{
  "templateId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "organizationId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}