Connectors Reference

Priority Matrix

Priority Matrix creates a central source of truth to coordinate all the work your team needs to do. Prioritize all your work, share with your team and focus on the high-impact tasks first. Connect now to manage your tasks automatically.

 

Status: Preview

Tier: Premium

Version: 1.0

 

Actions:

Name

Summary

AddCommentToItem (integer Project, AddCommentToItemParameterBody body)

Add Comment to Item

CreateItem (CreateItemParameterBody body)

Create Item

GetItem (integer ItemId)

Gets an Item

UpdateItem (integer ItemId, UpdateItemParameterBody body)

Update Item

GetProjects ([advanced]integer limit, [advanced]integer state, [advanced][Optional]string skip_tag)

Gets all projects

CreateProject ([Optional]CreateProjectParameterBody body)

Creates a Project

GetProject (integer ProjectId)

Gets Project

UpdateProject (integer ProjectId, [Optional]UpdateProjectParameterBody body)

Updates a Project

GetProjectItems (integer ProjectId, integer limit, integer state__lte)

Get Project Items

 

Triggers:

Name

Summary

ItemCompletedHook (ItemCompletedHookParameterBody body)

Item Was Completed

ItemCreatedHook (ItemCreatedHookParameterBody body)

Item Was Created

ItemDelegatedHook (ItemDelegatedHookParameterBody body)

Item Was Delegated

ItemDeletedHook (ItemDeletedHookParameterBody body)

Item Was Deleted

ItemDueHook (ItemDueHookParameterBody body)

Item is Due

ItemStartHook (ItemStartHookParameterBody body)

Item Starts now

 

Objects:

Name

Summary

AddCommentToItemParameterBody

 

AddCommentToItemResponse

 

CreateItemParameterBody

 

CreateItemResponse

 

CreateProjectParameterBody

 

CreateProjectResponse

 

GetItemResponse

 

GetProjectItemsResponse

 

GetProjectResponse

 

GetProjectsResponse

 

ItemCompletedHookParameterBody

 

ItemCompletedHookResponse

 

ItemCreatedHookParameterBody

 

ItemCreatedHookResponse

 

ItemDelegatedHookParameterBody

 

ItemDelegatedHookResponse

 

ItemDeletedHookParameterBody

 

ItemDeletedHookResponse

 

ItemDueHookParameterBody

 

ItemDueHookResponse

 

ItemStartHookParameterBody

 

ItemStartHookResponse

 

UpdateItemParameterBody

 

UpdateItemResponse

 

UpdateProjectParameterBody

 

UpdateProjectResponse

 

 

Actions:

AddCommentToItem

Summary: Add Comment to Item

Description: Add Comment to Item

 

Syntax:

PriorityMatrix.AddCommentToItem (integer Project, AddCommentToItemParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

Project

integer

(What project contains the item you want to comment on?)

Project that contains the desired item

True

GetProjects

body

AddCommentToItemParameterBody

 

 

True

 

Returns:

          Type:AddCommentToItemResponse

 

CreateItem

Summary: Create Item

Description: Create a new item

 

Syntax:

PriorityMatrix.CreateItem (CreateItemParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

CreateItemParameterBody

 

 

True

 

Returns:

          Type:CreateItemResponse

 

GetItem

Summary: Gets an Item

Description: Retrieves an item given its ID

 

Syntax:

PriorityMatrix.GetItem (integer ItemId)

 

Parameters:

Name

Type

Summary

Required

Related Action

ItemId

integer(int64)

(A positive integer that uniquely refers to the desired item)

Unique ID for the item

True

 

Returns:

          Type:GetItemResponse

 

UpdateItem

Summary: Update Item

Description: Update an existing item

 

Syntax:

PriorityMatrix.UpdateItem (integer ItemId, UpdateItemParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

ItemId

integer(int32)

(A positive integer that uniquely refers to the item)

Unique item ID

True

body

UpdateItemParameterBody

 

 

True

 

Returns:

          Type:UpdateItemResponse

 

GetProjects

Summary: Gets all projects

Description: Gets all the projects that the user can access

 

Syntax:

PriorityMatrix.GetProjects ([advanced]integer limit, [advanced]integer state, [advanced][Optional]string skip_tag)

 

Parameters:

Name

Type

Summary

Required

Related Action

limit

integer

(The maximum number of projects to be returned at once)

Number of projects to be returned

True

state

integer

(Pass state=0 for undeleted projects, or 2/3 for trashed/deleted projects)

State of retrieved projects

True

skip_tag

string

(For example, skip_tag=archived skips all archived projects)

Skip projects that contain this tag

False

 

Returns:

          Type:GetProjectsResponse

 

CreateProject

Summary: Creates a Project

Description: Creates a Project

 

Syntax:

PriorityMatrix.CreateProject ([Optional]CreateProjectParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

CreateProjectParameterBody

 

 

False

 

Returns:

          Type:CreateProjectResponse

 

GetProject

Summary: Gets Project

Description: Gets Project

 

Syntax:

PriorityMatrix.GetProject (integer ProjectId)

 

Parameters:

Name

Type

Summary

Required

Related Action

ProjectId

integer(int32)

(A positive integer that uniquely refers to the project)

ID of the desired project

True

GetProjects

 

Returns:

          Type:GetProjectResponse

 

UpdateProject

Summary: Updates a Project

Description: Updates a Project

 

Syntax:

PriorityMatrix.UpdateProject (integer ProjectId, [Optional]UpdateProjectParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

ProjectId

integer(int32)

(A positive integer that uniquely refers to the project)

ID of the desired project

True

body

UpdateProjectParameterBody

 

 

False

 

Returns:

          Type:UpdateProjectResponse

 

GetProjectItems

Summary: Get Project Items

Description: Get Project Items

 

Syntax:

PriorityMatrix.GetProjectItems (integer ProjectId, integer limit, integer state__lte)

 

Parameters:

Name

Type

Summary

Required

Related Action

ProjectId

integer(int32)

(A positive integer that uniquely refers to the project)

ID of the project for which items are requested

True

GetProjects

limit

integer

(The maximum number of items to be returned at once)

Number of items to be returned

True

state__lte

integer

(Retrieve only unfinished items, or include finished, even deleted ones)Values: [, , ]

Get only items with matching state

True

 

Returns:

          Type:GetProjectItemsResponse

 

Triggers:

Trigger ItemCompletedHook

Summary: Item Was Completed

Description: Item Was Completed

 

Syntax:

PriorityMatrix.ItemCompletedHook (ItemCompletedHookParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

ItemCompletedHookParameterBody

 

 

True

 

Returns:

          Type:ItemCompletedHookResponse

 

Trigger ItemCreatedHook

Summary: Item Was Created

Description: Item Was Created

 

Syntax:

PriorityMatrix.ItemCreatedHook (ItemCreatedHookParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

ItemCreatedHookParameterBody

 

 

True

 

Returns:

          Type:ItemCreatedHookResponse

 

Trigger ItemDelegatedHook

Summary: Item Was Delegated

Description: Item Was Delegated

 

Syntax:

PriorityMatrix.ItemDelegatedHook (ItemDelegatedHookParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

ItemDelegatedHookParameterBody

 

 

True

 

Returns:

          Type:ItemDelegatedHookResponse

 

Trigger ItemDeletedHook

Summary: Item Was Deleted

Description: Item Was Deleted

 

Syntax:

PriorityMatrix.ItemDeletedHook (ItemDeletedHookParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

ItemDeletedHookParameterBody

 

 

True

 

Returns:

          Type:ItemDeletedHookResponse

 

Trigger ItemDueHook

Summary: Item is Due

Description: Item Due

 

Syntax:

PriorityMatrix.ItemDueHook (ItemDueHookParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

ItemDueHookParameterBody

 

 

True

 

Returns:

          Type:ItemDueHookResponse

 

Trigger ItemStartHook

Summary: Item Starts now

Description: Item Started

 

Syntax:

PriorityMatrix.ItemStartHook (ItemStartHookParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

ItemStartHookParameterBody

 

 

True

 

Returns:

          Type:ItemStartHookResponse

 


 

AddCommentToItemParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

item

string

 

Item to comment on

text

string

 

What do you want to say in your comment?


 

AddCommentToItemResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

author

string

 

Author User

author_avatar

string

 

author_avatar

author_email

string

 

Author of the comment

author_fullname

string

 

author_fullname

color

string

 

color

html

string

 

html

id

integer(int32)

 

Id for the comment

interest_level

integer(int32)

 

interest_level

is_attention

boolean

 

is_attention

is_automatic

boolean

 

is_automatic

is_command

boolean

 

is_command

is_email

boolean

 

is_email

is_read

boolean

 

is_read

item

string

 

item URI for the comment

item_completed

boolean

 

item_completed

item_deleted

boolean

 

item_deleted

item_name

string

 

item_name

json

string

 

json

num_comments

integer(int32)

 

num_comments

object_id

string

 

object_id

order

integer(int32)

 

order

project

string

 

Project URI for the comment

project_name

string

 

project_name

project_state

integer(int32)

 

project_state

resource_uri

string

 

URI that points to this resource in our API

source_email

string

 

source_email

target_email

string

 

target_email

text

string

 

Text for the comment

timestamp

number(float)

 

When the comment happened, given in seconds since 1970

tooltip

string

 

tooltip


 

CreateItemParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

boxFolderID

string

 

Use this field to store an ID or URI for this object in another system

completionPercentage

integer(int32)

 

Percentage of this task that is completed, ranging from 0 to 100

descriptionText

string

 

Notes for the item, with an extended description of the task at hand

dueDate

string(date-time)

 

When this item is due

effort

integer(int32)

 

effort

estimatedEffort

integer(int32)

 

estimatedEffort

macResourceURI

string

 

A link to a relevant resource relevant (a website, another item, a project...)

name

string

 

name

owner_username

string

 

Who is responsible for this item?

projects

array of (string)

 

List of projects which contain the item (typically a single project)

quadrant

integer(int32)

 

Quadrant choice, left to right and top to bottom  Values: [, , , ]

startDate

string(date-time)

 

When this item is scheduled to start


 

CreateItemResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

allDay

boolean

 

True if the item has a due date and it's supposed to last a full day

boxFolderID

string

 

Use this field to store an ID or URI for this object in another system

childID

integer(int32)

 

Next-in-line item, when using recurrence

completed_by

string

 

completed_by

completed_by_username

string

 

Who completed the item

completionDateObject

string(date-time)

 

When this item was completed

completionPercentage

integer(int32)

 

Percentage of this task that is completed, ranging from 0 to 100

creationDateObject

string(date-time)

 

When this item was created

creator

string

 

creator

creator_username

string

 

Who created the item

delegated_by

string

 

delegated_by

delegated_by_username

string

 

Who delegated the item the last time

delegationTimestamp

string

 

delegationTimestamp

descriptionRichText

string

 

descriptionRichText

descriptionText

string

 

Notes for the item, with an extended description of the task at hand

dueDateObject

string(date-time)

 

When this item is due

editedByDevice

string

 

editedByDevice

edited_by

string

 

edited_by

edited_by_username

string

 

edited_by_username

effort

integer(int32)

 

effort

estimatedEffort

integer(int32)

 

estimatedEffort

files

array of (string)

 

files

following

boolean

 

True if the requesting user follows the item

frequency

string

 

frequency

icon

string

 

icon

id

integer(int32)

 

id

idd

integer(int32)

 

idd

index

integer(int32)

 

index

lastModifiedTimestamp

string

 

lastModifiedTimestamp

last_attention

number(float)

 

last_attention

macResourceURL

string

 

A link to a relevant resource relevant (a website, another item, a project...)

name

string

 

Name for the item

owner

string

 

owner

owner_username

string

 

Who is responsible for this item?

parentID

integer(int32)

 

Precursor item, when using recurrence

projects

array of (string)

 

List of projects which contain the item (typically a single project)

quadrant

integer(int32)

 

Quadrant choice, left to right and top to bottom  Values: [, , , ]

realizedEffort

integer(int32)

 

realizedEffort

recurrence

string

 

recurrence

recurrence_text

string

 

recurrence_text

reminder

string

 

reminder

requested_time

number(float)

 

requested_time

resource_uri

string

 

URI that points to this resource in our API

startDateObject

string(date-time)

 

Datetime the item is scheduled to start

state

integer(int32)

 

state

tags

array of (TagsItem)

 

tags

timestamp

number(float)

 

Last time the item was modified, given in seconds since 1970

untilDate

string

 

untilDate

version_id

integer(int32)

 

version_id

webLink

string

 

URL to open this item in Priority Matrix

 

TagsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

 

id

name

string

 

name

resource_uri

string

 

URI that points to this resource in our API

slug

string

 

slug

 


 

CreateProjectParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

endDate

string(date-time)

 

When the project ends

name

string

 

Name for the project

notes

string

 

Notes for the project

startDate

string(date-time)

 

When the project starts

textFirstQuadrant

string

 

Title for the first quadrant

textFourthQuadrant

string

 

Title for the fourth quadrant

textSecondQuadrant

string

 

Title for the second quadrant

textThirdQuadrant

string

 

Title for the third quadrant


 

CreateProjectResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

meta

Meta

 

meta

objects

array of (ObjectsItem)

 

objects

 

Meta

Summary:

Description: meta

 

          Properties:

Name

Type

Summary

limit

integer(int32)

 

limit

next

string

 

next

offset

integer(int32)

 

offset

previous

string

 

previous

requested_time

integer(int32)

 

requested_time

server_time

number(float)

 

server_time

total_count

integer(int32)

 

total_count

 

ObjectsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

account_uri

string

 

account_uri

boxFolderID

string

 

Use this field to store an ID or URI for this object in another system

colorFirstQuadrant

string

 

colorFirstQuadrant

colorFourthQuadrant

string

 

colorFourthQuadrant

colorSecondQuadrant

string

 

colorSecondQuadrant

colorThirdQuadrant

string

 

colorThirdQuadrant

completed_effort

integer(int32)

 

completed_effort

creationDateObject

string(date-time)

 

When this project was created

creator

string

 

creator

creator_username

string

 

Who created the project

editedByDevice

string

 

editedByDevice

edited_by_username

string

 

edited_by_username

endDateObject

string(date-time)

 

When the project ends

hash

string

 

hash

idd

integer(int32)

 

Id for the project

index

integer(int32)

 

index

is_team_project

boolean

 

True if the project is shared with all team members

name

string

 

Name for the project

notes

string

 

Notes for the project

owner

array of (string)

 

owner

owners_count

integer(int32)

 

owners_count

requested_time

number(float)

 

requested_time

resource_uri

string

 

URI that points to this resource in our API

startDateObject

string(date-time)

 

When the project starts

state

integer(int32)

 

state

tags

array of (TagsItem)

 

tags

templateCreationDate

integer(int32)

 

templateCreationDate

textFirstQuadrant

string

 

Title for the first quadrant

textFourthQuadrant

string

 

Title for the for the fourth quadrant

textSecondQuadrant

string

 

Title for the second quadrant

textThirdQuadrant

string

 

Title for the third quadrant

timestamp

number(float)

 

Last time the project was modified, given in seconds since 1970

total_effort

integer(int32)

 

total_effort

user_group_id

string

 

user_group_id

version_id

integer(int32)

 

version_id

 

TagsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

 

id

name

string

 

name

resource_uri

string

 

resource_uri

slug

string

 

slug

 


 

GetItemResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

allDay

boolean

 

True if the item has a due date and it's supposed to last a full day

boxFolderID

string

 

Use this field to store an ID or URI for this object in another system

childID

integer(int32)

 

Next-in-line item, when using recurrence

completed_by

string

 

completed_by

completed_by_username

string

 

Who completed the item

completionDateObject

string(date-time)

 

When this item was completed

completionPercentage

integer(int32)

 

Percentage of this task that is completed, ranging from 0 to 100

creationDateObject

string(date-time)

 

When this item was created

creator

string

 

creator

creator_username

string

 

Who created the item

delegated_by

string

 

delegated_by

delegated_by_username

string

 

Who delegated the item the last time

delegationTimestamp

string

 

delegationTimestamp

descriptionRichText

string

 

descriptionRichText

descriptionText

string

 

Notes for the item, with an extended description of the task at hand

dueDateObject

string(date-time)

 

When this item is due

editedByDevice

string

 

editedByDevice

edited_by

string

 

edited_by

edited_by_username

string

 

edited_by_username

effort

integer(int32)

 

effort

estimatedEffort

integer(int32)

 

estimatedEffort

files

array of (string)

 

files

following

boolean

 

True if the requesting user follows the item

frequency

string

 

frequency

icon

string

 

icon

id

integer(int32)

 

id

idd

integer(int32)

 

idd

index

integer(int32)

 

index

lastModifiedTimestamp

string

 

lastModifiedTimestamp

last_attention

number(float)

 

last_attention

last_comment

string

 

last_comment

last_comment_id

integer(int32)

 

last_comment_id

last_read

number(float)

 

last_read

macResourceURL

string

 

A link to a relevant resource relevant (a website, another item, a project...)

name

string

 

Name for the item

owner

string

 

owner

owner_username

string

 

Who is responsible for this item?

parentID

integer(int32)

 

Precursor item, when using recurrence

projects

array of (string)

 

List of projects which contain the item (typically a single project)

quadrant

integer(int32)

 

Quadrant choice, left to right and top to bottom  Values: [, , , ]

realizedEffort

integer(int32)

 

realizedEffort

recurrence

string

 

recurrence

recurrence_text

string

 

recurrence_text

reminder

string

 

reminder

requested_time

number(float)

 

requested_time

resource_uri

string

 

URI that points to this resource in our API

startDateObject

string(date-time)

 

When this item is scheduled to start

state

integer(int32)

 

state

tags

array of (TagsItem)

 

tags

timestamp

number(float)

 

Last time the item was modified, given in seconds since 1970

untilDate

integer(int32)

 

untilDate

version_id

integer(int32)

 

version_id

webLink

string

 

URL to open this item in Priority Matrix

 

TagsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

 

id

name

string

 

name

resource_uri

string

 

URI that points to this resource in our API

slug

string

 

slug

 


 

GetProjectItemsResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

meta

Meta

 

meta

objects

array of (ObjectsItem)

 

objects

 

Meta

Summary:

Description: meta

 

          Properties:

Name

Type

Summary

limit

integer(int32)

 

limit

next

string

 

next

offset

integer(int32)

 

offset

previous

string

 

previous

requested_time

number(float)

 

requested_time

 

ObjectsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

allDay

boolean

 

True if the item has a due date and it's supposed to last a full day

boxFolderID

string

 

Use this field to store an ID or URI for this object in another system

childID

integer(int32)

 

Next-in-line item, when using recurrence

completed_by

string

 

completed_by

completed_by_username

string

 

Who completed the item

completionDateObject

string(date-time)

 

When this item was completed

completionPercentage

integer(int32)

 

Percentage of this task that is completed, ranging from 0 to 100

copiedFromID

integer(int32)

 

copiedFromID

creationDateObject

string(date-time)

 

When this item was created

creator

string

 

creator

creator_username

string

 

Who created the item

delegated_by

string

 

delegated_by

delegated_by_username

string

 

Who delegated the item the last time

delegationTimestamp

string

 

delegationTimestamp

descriptionRichText

string

 

descriptionRichText

descriptionText

string

 

Notes for the item, with an extended description of the task at hand

dueDateObject

string(date-time)

 

When this item is due

editedByDevice

string

 

editedByDevice

edited_by

string

 

edited_by

edited_by_username

string

 

edited_by_username

effort

integer(int32)

 

effort

estimatedEffort

integer(int32)

 

estimatedEffort

files

array of (FilesItem)

 

files

following

boolean

 

True if the requesting user follows the item

frequency

string

 

frequency

icon

string

 

icon

id

integer(int32)

 

id

idd

integer(int32)

 

idd

index

integer(int32)

 

index

lastModifiedTimestamp

integer(int32)

 

Last time the item was modified, given in seconds since 1970

last_comment

string

 

last_comment

last_comment_id

integer(int32)

 

last_comment_id

macResourceURL

string

 

A link to a relevant resource relevant (a website, another item, a project...)

name

string

 

Name for the item

owner

string

 

owner

owner_username

string

 

Who is responsible for this item?

parentID

integer(int32)

 

Precursor item, when using recurrence

projects

array of (string)

 

List of projects which contain the item (typically a single project)

quadrant

integer(int32)

 

Quadrant choice, left to right and top to bottom  Values: [, , , ]

realizedEffort

integer(int32)

 

realizedEffort

recurrence

integer(int32)

 

recurrence

recurrence_text

string

 

recurrence_text

reminder

string

 

reminder

requested_time

number(float)

 

requested_time

resource_uri

string

 

URI that points to this resource in our API

startDateObject

string(date-time)

 

Datetime the item is scheduled to start

state

integer(int32)

 

state

tags

array of (TagsItem)

 

tags

timestamp

number(float)

 

Last time the item was modified, given in seconds since 1970

untilDate

integer(int32)

 

untilDate

version_id

integer(int32)

 

version_id

webLink

string

 

URL to open this item in Priority Matrix

 

FilesItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

cached_size

integer(int32)

 

cached_size

content_type

string

 

content_type

filename

string

 

filename

height

integer(int32)

 

height

id

integer(int32)

 

id

item

string

 

item

md5sum

string

 

md5sum

owner

string

 

owner

resource_uri

string

 

resource_uri

size

integer(int32)

 

size

timestamp

integer(int32)

 

timestamp

url

string

 

url

width

integer(int32)

 

width

 

TagsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

 

id

name

string

 

name

resource_uri

string

 

resource_uri

slug

string

 

slug

 


 

GetProjectResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

account_uri

string

 

account_uri

boxFolderID

string

 

Use this field to store an ID or URI for this object in another system

colorFirstQuadrant

string

 

colorFirstQuadrant

colorFourthQuadrant

string

 

colorFourthQuadrant

colorSecondQuadrant

string

 

colorSecondQuadrant

colorThirdQuadrant

string

 

colorThirdQuadrant

completed_effort

integer(int32)

 

completed_effort

creationDateObject

string(date-time)

 

When this project was created

creator

string

 

creator

creator_username

string

 

Who created the project

editedByDevice

string

 

editedByDevice

edited_by_username

string

 

edited_by_username

endDateObject

string(date-time)

 

When the project ends

hash

string

 

hash

idd

integer(int32)

 

Id for the project

index

integer(int32)

 

index

is_team_project

boolean

 

True if the project is shared with all team members

name

string

 

Name for the project

notes

string

 

Notes for the project

owner

array of (string)

 

owner

owners_count

integer(int32)

 

owners_count

requested_time

number(float)

 

requested_time

resource_uri

string

 

URI that points to this resource in our API

startDateObject

string(date-time)

 

When the project starts

state

integer(int32)

 

state

tags

array of (TagsItem)

 

tags

templateCreationDate

string

 

templateCreationDate

textFirstQuadrant

string

 

Title for the first quadrant

textFourthQuadrant

string

 

Title for the fourth quadrant

textSecondQuadrant

string

 

Title for the second quadrant

textThirdQuadrant

string

 

Title for the third quadrant

timestamp

number(float)

 

Last time the project was modified, given in seconds since 1970

total_effort

integer(int32)

 

total_effort

user_group_id

string

 

user_group_id

version_id

integer(int32)

 

version_id

 

TagsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

 

id

name

string

 

name

resource_uri

string

 

URI that points to this resource in our API

slug

string

 

slug

 


 

GetProjectsResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

meta

Meta

 

meta

objects

array of (ObjectsItem)

 

objects

 

Meta

Summary:

Description: meta

 

          Properties:

Name

Type

Summary

limit

integer(int32)

 

limit

next

string

 

next

offset

integer(int32)

 

offset

previous

string

 

previous

requested_time

integer(int32)

 

requested_time

server_time

number(float)

 

server_time

total_count

integer(int32)

 

total_count

 

ObjectsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

account_uri

string

 

account_uri

boxFolderID

string

 

Use this field to store an ID or URI for this object in another system

colorFirstQuadrant

string

 

colorFirstQuadrant

colorFourthQuadrant

string

 

colorFourthQuadrant

colorSecondQuadrant

string

 

colorSecondQuadrant

colorThirdQuadrant

string

 

colorThirdQuadrant

completed_effort

integer(int32)

 

completed_effort

creationDateObject

string(date-time)

 

When this item was created

creator

string

 

creator

creator_username

string

 

Who created the project

editedByDevice

string

 

editedByDevice

edited_by_username

string

 

edited_by_username

endDateObject

string(date-time)

 

When the project ends

hash

string

 

hash

idd

integer(int32)

 

Id for the project

index

integer(int32)

 

index

is_team_project

boolean

 

True if the project is shared with all team members

name

string

 

Name for the project

notes

string

 

Notes for the project

owner

array of (string)

 

owner

owners_count

integer(int32)

 

owners_count

requested_time

number(float)

 

requested_time

resource_uri

string

 

URI that points to this resource in our API

startDateObject

string(date-time)

 

When the project starts

state

integer(int32)

 

state

tags

array of (TagsItem)

 

tags

templateCreationDate

integer(int32)

 

templateCreationDate

textFirstQuadrant

string

 

Title for the first quadrant

textFourthQuadrant

string

 

Title for the fourth quadrant

textSecondQuadrant

string

 

Title for the second quadrant

textThirdQuadrant

string

 

Title for the third quadrant

timestamp

number(float)

 

Last time the project was modified, given in seconds since 1970

total_effort

integer(int32)

 

total_effort

user_group_id

string

 

user_group_id

version_id

integer(int32)

 

version_id

 

TagsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

 

id

name

string

 

name

resource_uri

string

 

resource_uri

slug

string

 

slug

 


 

ItemCompletedHookParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

project

string

 

Choose the containing project

target

string

 

target


 

ItemCompletedHookResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

account

string

 

account for the hook. it can be null

enabled

boolean

 

if the hook is enabled or not

event

string

 

type of hook

resource_uri

string

 

resource uri for hook

target

string

 

url that gets called

user

string

 

user that owns the hook


 

ItemCreatedHookParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

project

string

 

Choose the containing project

target

string

 

target


 

ItemCreatedHookResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

account

string

 

account for the hook. it can be null

enabled

boolean

 

if the hook is enabled or not

event

string

 

type of hook

resource_uri

string

 

resource uri for hook

target

string

 

url that gets called

user

string

 

user that owns the hook


 

ItemDelegatedHookParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

project

string

 

Choose the containing project

target

string

 

target


 

ItemDelegatedHookResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

account

string

 

account for the hook. it can be null

enabled

boolean

 

if the hook is enabled or not

event

string

 

type of hook

resource_uri

string

 

resource uri for hook

target

string

 

url that gets called

user

string

 

user that owns the hook


 

ItemDeletedHookParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

project

string

 

Choose the containing project

target

string

 

target


 

ItemDeletedHookResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

account

string

 

account for the hook. it can be null

enabled

boolean

 

if the hook is enabled or not

event

string

 

type of hook

resource_uri

string

 

resource uri for hook

target

string

 

url that gets called

user

string

 

user that owns the hook


 

ItemDueHookParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

project

string

 

Choose the containing project

target

string

 

target


 

ItemDueHookResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

account

string

 

account for the hook. it can be null

enabled

boolean

 

if the hook is enabled or not

event

string

 

type of hook

resource_uri

string

 

resource uri for hook

target

string

 

url that gets called

user

string

 

user that owns the hook


 

ItemStartHookParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

project

string

 

Choose the containing project

target

string

 

target


 

ItemStartHookResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

account

string

 

account for the hook. it can be null

enabled

boolean

 

if the hook is enabled or not

event

string

 

type of hook

resource_uri

string

 

resource uri for hook

target

string

 

url that gets called

user

string

 

user that owns the hook


 

UpdateItemParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

boxFolderID

string

 

Use this field to store an ID or URI for this object in another system

completionPercentage

integer(int32)

 

Percentage of this task that is completed, ranging from 0 to 100

descriptionText

string

 

Notes for the item, with an extended description of the task at hand

dueDate

string(date-time)

 

When this item is due

effort

integer(int32)

 

effort

estimatedEffort

integer(int32)

 

estimatedEffort

macResourceURI

string

 

A link to a relevant resource relevant (a website, another item, a project...)

name

string

 

Name for the item

owner_username

string

 

Who is responsible for this item?

projects

array of (string)

 

List of projects which contain the item (typically a single project)

quadrant

integer(int32)

 

Quadrant choice, left to right and top to bottom  Values: [, , , ]

startDate

string(date-time)

 

When this item is scheduled to start


 

UpdateItemResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

allDay

boolean

 

True if the item has a due date and it's supposed to last a full day

boxFolderID

string

 

Use this field to store an ID or URI for this object in another system

childID

integer(int32)

 

Next-in-line item, when using recurrence

completed_by

string

 

completed_by

completed_by_username

string

 

Who completed the item

completionDateObject

string(date-time)

 

When this item was completed

completionPercentage

integer(int32)

 

Percentage of this task that is completed, ranging from 0 to 100

creationDateObject

string(date-time)

 

When this item was created

creator

string

 

creator

creator_username

string

 

Who created the item

delegated_by

string

 

delegated_by

delegated_by_username

string

 

Who delegated the item the last time

delegationTimestamp

string

 

delegationTimestamp

descriptionRichText

string

 

descriptionRichText

descriptionText

string

 

Notes for the item, with an extended description of the task at hand

dueDateObject

string(date-time)

 

When this item is due

editedByDevice

string

 

editedByDevice

edited_by

string

 

edited_by

edited_by_username

string

 

edited_by_username

effort

integer(int32)

 

effort

estimatedEffort

integer(int32)

 

estimatedEffort

files

array of (string)

 

files

following

boolean

 

True if the requesting user follows the item

frequency

string

 

frequency

icon

string

 

icon

id

integer(int32)

 

id

idd

integer(int32)

 

idd

index

integer(int32)

 

index

lastModifiedTimestamp

string

 

lastModifiedTimestamp

last_attention

number(float)

 

last_attention

macResourceURL

string

 

A link to a relevant resource relevant (a website, another item, a project...)

name

string

 

Name for the item

owner

string

 

owner

owner_username

string

 

Who is responsible for this item?

parentID

integer(int32)

 

Precursor item, when using recurrence

projects

array of (string)

 

List of projects which contain the item (typically a single project)

quadrant

integer(int32)

 

Quadrant choice, left to right and top to bottom  Values: [, , , ]

realizedEffort

integer(int32)

 

realizedEffort

recurrence

string

 

recurrence

recurrence_text

string

 

recurrence_text

reminder

string

 

reminder

requested_time

number(float)

 

requested_time

resource_uri

string

 

URI that points to this resource in our API

startDateObject

string(date-time)

 

When this item is scheduled to start

state

integer(int32)

 

state

tags

array of (TagsItem)

 

tags

timestamp

number(float)

 

Last time the item was modified, given in seconds since 1970

untilDate

string

 

untilDate

version_id

integer(int32)

 

version_id

webLink

string

 

URL to open this item in Priority Matrix

 

TagsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

 

id

name

string

 

name

resource_uri

string

 

URI that points to this resource in our API

slug

string

 

slug

 


 

UpdateProjectParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

endDate

string(date-time)

 

When this project ends

name

string

 

Name for the project

notes

string

 

Notes for the project

startDate

string(date-time)

 

When the project starts

textFirstQuadrant

string

 

Title for the first quadrant

textFourthQuadrant

string

 

Title for the fourth quadrant

textSecondQuadrant

string

 

Title for the second quadrant

textThirdQuadrant

string

 

Title for the third quadrant


 

UpdateProjectResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

meta

Meta

 

meta

objects

array of (ObjectsItem)

 

objects

 

Meta

Summary:

Description: meta

 

          Properties:

Name

Type

Summary

limit

integer(int32)

 

limit

next

string

 

next

offset

integer(int32)

 

offset

previous

string

 

previous

requested_time

integer(int32)

 

requested_time

server_time

number(float)

 

server_time

total_count

integer(int32)

 

total_count

 

ObjectsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

account_uri

string

 

account_uri

boxFolderID

string

 

Use this field to store an ID or URI for this object in another system

colorFirstQuadrant

string

 

colorFirstQuadrant

colorFourthQuadrant

string

 

colorFourthQuadrant

colorSecondQuadrant

string

 

colorSecondQuadrant

colorThirdQuadrant

string

 

colorThirdQuadrant

completed_effort

integer(int32)

 

completed_effort

creationDateObject

string(date-time)

 

When this project was created

creator

string

 

creator

creator_username

string

 

Who created the project

editedByDevice

string

 

editedByDevice

edited_by_username

string

 

edited_by_username

endDateObject

string(date-time)

 

When the project ends

hash

string

 

hash

idd

integer(int32)

 

Id for the project

index

integer(int32)

 

index

is_team_project

boolean

 

True if the project is shared with all team members

name

string

 

Name for the project

notes

string

 

Notes for the project

owner

array of (string)

 

owner

owners_count

integer(int32)

 

owners_count

requested_time

number(float)

 

requested_time

resource_uri

string

 

URI that points to this resource in our API

startDateObject

string(date-time)

 

When the project starts

state

integer(int32)

 

state

tags

array of (TagsItem)

 

tags

templateCreationDate

integer(int32)

 

templateCreationDate

textFirstQuadrant

string

 

Title for the first quadrant

textFourthQuadrant

string

 

Title for the fourth quadrant

textSecondQuadrant

string

 

Title for the second quadrant

textThirdQuadrant

string

 

Title for the third quadrant

timestamp

number(float)

 

Last time the project was modified, given in seconds since 1970

total_effort

integer(int32)

 

total_effort

user_group_id

string

 

user_group_id

version_id

integer(int32)

 

version_id

 

TagsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

 

id

name

string

 

name

resource_uri

string

 

resource_uri

slug

string

 

slug