Task Purpose

A collection of task purposes that help categorize your tasks.

createdAt
string <date-time>

The date and time the task purpose was created.

name
string <= 255 characters

The purpose’s name (e.g. "Initial Contact").

order
integer

The purpose’s display order within the collection.

taskType
string <= 255 characters

The purpose’s task type (e.g. "Meeting in Person").

updatedAt
string <date-time>

The date and time the task purpose was last updated.

{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "order": 0,
  • "taskType": "string",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Task Purpose Relationships

(user (data (object) or links (object)))

The creator of the task purpose. Relationship creator cannot be used as a filter.

Array of links (object) (task)

The tasks made with this purpose. Relationship tasks cannot be used as a filter.

{
  • "creator": {
    },
  • "tasks": [
    ]
}

Task Purpose Resource Metadata

METADATA NAME DESCRIPTION QUERY PARAM
canWrite A boolean value indicating whether the current API user has write access to this resource. provideAuthorizationMeta
canDelete A boolean value indicating whether the current API user has delete access to this resource. provideAuthorizationMeta

⌵ Task Purpose Actions

Get a Collection of Task Purposes

SecuritybearerAuth
Responses
200

OK

422

JSON error message

get/taskPurposes
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": [
    ]
}
Create a New Task Purpose
SecuritybearerAuth 
Request 
Request Body schema: application/vnd.api+json
required
object
 
Responses 
201
Created


422
JSON error message


post/taskPurposes
Request samples 
application/vnd.api+json
{
  • "data": {
    }
}
Response samples 
application/vnd.api+json
{
  • "data": {
    }
}
Delete an Existing Task Purpose by ID
SecuritybearerAuth 
Request 
path Parameters
id
required
integer
 
Responses 
204
Deleted


422
JSON error message


delete/taskPurposes/{id}
Request samples 
Response samples 
application/vnd.api+json
{
  • "errors": [
    ]
}
Get a Task Purpose by ID
SecuritybearerAuth 
Request 
path Parameters
id
required
integer
 
Responses 
200
OK


404
Not Found


get/taskPurposes/{id}
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": {
    }
}
Update a Task Purpose
SecuritybearerAuth 
Request 
path Parameters
id
required
integer
 
Request Body schema: application/vnd.api+json
required
object
 
Responses 
200
OK


422
JSON error message


patch/taskPurposes/{id}
Request samples 
application/vnd.api+json
{
  • "data": {
    }
}
Response samples 
application/vnd.api+json
{
  • "data": {
    }
}