List tasks

Get all tasks for a given query.

GET

/ v1 / tasks

Authorization

X-API-Key

string

required

Header with the name X-API-Key where the value is your API key.

Query parameters

assigneeId

string

Limit tasks returned to a specific assignee.
cursor

string

Use if a previous request returned a cursor. Will page through results.
includeAllStatuses

boolean

Limit tasks returned by statuses that exist on tasks, cannot specify this ('includeAllStatuses') AND status in the same request.
label

string

Limit tasks returned by label on the task.
name

string

Limit tasks returned to those that contain this string. Case in-sensitive.
projectId

string

Limit tasks returned to a given project.
status

array<string>

Limit tasks returned by statuses that exist on tasks, cannot specify this ('status') AND includeAllStatuses in the same request
workspaceId

string

The id of the workspace you want tasks from. If not provided, will return tasks from all workspaces the user is a member of.

Response

200 - application/json - object

meta

object

required

Contains the nextCursor, if one exists, along with the pageSize.
- nextCursor
  
  string
  
  Make the same query with the new cursor to get more results.
- pageSize
  
  number
  
  The number of results in this response.
tasks

array<object>

required

The tasks returned.
- id
  
  string
  
  required
  
  The ID of the task.
- name
  
  string
  
  required
  
  The name of the task.
- description
  
  string
  
  required
  
  The HTML contents of the description.
- duration
  
  string | number
  
  An integer greater than 0 (representing minutes), "NONE", or "REMINDER".
- dueDate
  
  datetime
  
  When is the task due.
- deadlineType
  
  string
  
  required
  
  Values are HARD, SOFT (default) or NONE.
- parentRecurringTaskId
  
  string
  
  required
  
  If this is an instance of a recurring task, this field will be the parent recurring task id.
- completed
  
  boolean
  
  required
  
  Whether the task is completed or not.
- completedTime
  
  datetime
  
  The timestamp when the task was completed.
- updatedTime
  
  datetime
  
  The timestamp when the task was last updated.
- startOn
  
  string
  
  Date indicating when a task should start, in YYYY-MM-DD format.
- creator
  
  object
  
  required
  
  The user who created the task.
  id
  
  string
  
  The user id of the creator.
  
  name
  
  string
  
  The name of the creator.
  
  email
  
  string
  
  The email of the creator.
- project
  
  object
  
  The project data.
  id
  
  string
  
  required
  
  The ID of the project.
  
  name
  
  string
  
  required
  
  The name of the project.
  
  description
  
  string
  
  required
  
  The HTML contents of the description.
  
  workspaceId
  
  string
  
  required
  
  The ID of the workspace.
  
  status
  
  object
  
  The status of the project.
  
  name
  
  string
  
  The name of the status.
  
  isDefaultStatus
  
  boolean
  
  Whether this status is a default status for the workspace.
  
  isResolvedStatus
  
  boolean
  
  Whether this is a resolved (terminated) status for the workspace.
  
  createdTime
  
  datetime
  
  The timestamp when the project was created.
  
  updatedTime
  
  datetime
  
  The timestamp when the project was last updated.
  
  customFieldValues
  
  record<object>
  
  Record of custom field values for the entity, where each key is the name of the custom field (not the ID). Each object contains a "type" discriminator and a "value" property that varies based on the field type.
  
  text
  
  object
  
  Text custom field value.
  
  type
  
  string
  
  required
  
  Always "text" for this field type.
  
  value
  
  string | null
  
  Text value or null.
  
  number
  
  object
  
  Number custom field value.
  
  type
  
  string
  
  required
  
  Always "number" for this field type.
  
  value
  
  number | null
  
  Numeric value or null.
  
  url
  
  object
  
  URL custom field value.
  
  type
  
  string
  
  required
  
  Always "url" for this field type.
  
  value
  
  string | null
  
  URL string or null.
  
  date
  
  object
  
  Date custom field value.
  
  type
  
  string
  
  required
  
  Always "date" for this field type.
  
  value
  
  string | null
  
  ISO date string or null.
  
  select
  
  object
  
  Select custom field value.
  
  type
  
  string
  
  required
  
  Always "select" for this field type.
  
  value
  
  string | null
  
  Selected option value or null.
  
  multiSelect
  
  object
  
  Multi-select custom field value.
  
  type
  
  string
  
  required
  
  Always "multiSelect" for this field type.
  
  value
  
  array<string> | null
  
  Array of selected option values or null.
  
  person
  
  object
  
  Person custom field value.
  
  type
  
  string
  
  required
  
  Always "person" for this field type.
  
  value
  
  object | null
  
  Person object or null.
  
  id
  
  string
  
  required
  
  User ID of the person.
  
  name
  
  string
  
  required
  
  Name of the person.
  
  email
  
  string
  
  required
  
  Email of the person.
  
  multiPerson
  
  object
  
  Multi-person custom field value.
  
  type
  
  string
  
  required
  
  Always "multiPerson" for this field type.
  
  value
  
  array<object> | null
  
  Array of person objects or null.
  
  [index]
  
  object
  
  Person object.
  
  id
  
  string
  
  required
  
  User ID of the person.
  
  name
  
  string
  
  required
  
  Name of the person.
  
  email
  
  string
  
  required
  
  Email of the person.
  
  email
  
  object
  
  Email custom field value.
  
  type
  
  string
  
  required
  
  Always "email" for this field type.
  
  value
  
  string | null
  
  Email address or null.
  
  phone
  
  object
  
  Phone custom field value.
  
  type
  
  string
  
  required
  
  Always "phone" for this field type.
  
  value
  
  string | null
  
  Phone number or null.
  
  checkbox
  
  object
  
  Checkbox custom field value.
  
  type
  
  string
  
  required
  
  Always "checkbox" for this field type.
  
  value
  
  boolean | null
  
  Boolean value or null.
  
  relatedTo
  
  object
  
  Related task custom field value.
  
  type
  
  string
  
  required
  
  Always "relatedTo" for this field type.
  
  value
  
  string | null
  
  Related task ID or null.
- workspace
  
  object
  
  required
  
  The workspace data.
  id
  
  string
  
  required
  
  The ID of the workspace.
  
  name
  
  string
  
  required
  
  The name of the workspace.
  
  teamId
  
  string
  
  required
  
  The ID of the team.
  
  type
  
  string
  
  required
  
  Whether the workspace is a team or individual type.
  
  labels
  
  array<object>
  
  required
  
  An array of labels.
  
  name
  
  string
  
  The name of the label.
  
  statuses
  
  array<object>
  
  required
  
  An array of statuses for the workspace.
  
  name
  
  string
  
  The name of the status.
  
  isDefaultStatus
  
  boolean
  
  Whether this status is a default status for the workspace.
  
  isResolvedStatus
  
  boolean
  
  Whether this is a resolved (terminated) status for the workspace.
- status
  
  object
  
  required
  
  The status of the The status of the task.
  name
  
  string
  
  The name of the status.
  
  isDefaultStatus
  
  boolean
  
  Whether this status is a default status for the workspace.
  
  isResolvedStatus
  
  boolean
  
  Whether this is a resolved (terminated) status for the workspace.
- priority
  
  string
  
  required
  
  Valid options are ASAP, HIGH, MEDIUM, or LOW.
- labels
  
  array<object>
  
  required
  
  An array of labels.
  name
  
  string
  
  The name of the label.
- assignees
  
  array<object>
  
  required
  
  An array of assignees.
  id
  
  string
  
  required
  
  The user ID.
  
  name
  
  string
  
  The name of the user.
  
  email
  
  string
  
  required
  
  The email of the user.
- scheduledStart
  
  datetime
  
  The time that motion has scheduled this task to start.
- createdTime
  
  datetime
  
  required
  
  The time that the task was created.
- scheduledEnd
  
  datetime
  
  The time that motion has scheduled this task to end.
- schedulingIssue
  
  boolean
  
  required
  
  Returns true if Motion was unable to schedule this task. Check Motion directly to address.
- lastInteractedTime
  
  datetime
  
  The timestamp when the task was last interacted with.
- customFieldValues
  
  record<object>
  
  Record of custom field values for the entity, where each key is the name of the custom field (not the ID). Each object contains a "type" discriminator and a "value" property that varies based on the field type.
  text
  
  object
  
  Text custom field value.
  
  type
  
  string
  
  required
  
  Always "text" for this field type.
  
  value
  
  string | null
  
  Text value or null.
  
  number
  
  object
  
  Number custom field value.
  
  type
  
  string
  
  required
  
  Always "number" for this field type.
  
  value
  
  number | null
  
  Numeric value or null.
  
  url
  
  object
  
  URL custom field value.
  
  type
  
  string
  
  required
  
  Always "url" for this field type.
  
  value
  
  string | null
  
  URL string or null.
  
  date
  
  object
  
  Date custom field value.
  
  type
  
  string
  
  required
  
  Always "date" for this field type.
  
  value
  
  string | null
  
  ISO date string or null.
  
  select
  
  object
  
  Select custom field value.
  
  type
  
  string
  
  required
  
  Always "select" for this field type.
  
  value
  
  string | null
  
  Selected option value or null.
  
  multiSelect
  
  object
  
  Multi-select custom field value.
  
  type
  
  string
  
  required
  
  Always "multiSelect" for this field type.
  
  value
  
  array<string> | null
  
  Array of selected option values or null.
  
  person
  
  object
  
  Person custom field value.
  
  type
  
  string
  
  required
  
  Always "person" for this field type.
  
  value
  
  object | null
  
  Person object or null.
  
  id
  
  string
  
  required
  
  User ID of the person.
  
  name
  
  string
  
  required
  
  Name of the person.
  
  email
  
  string
  
  required
  
  Email of the person.
  
  multiPerson
  
  object
  
  Multi-person custom field value.
  
  type
  
  string
  
  required
  
  Always "multiPerson" for this field type.
  
  value
  
  array<object> | null
  
  Array of person objects or null.
  
  [index]
  
  object
  
  Person object.
  
  id
  
  string
  
  required
  
  User ID of the person.
  
  name
  
  string
  
  required
  
  Name of the person.
  
  email
  
  string
  
  required
  
  Email of the person.
  
  email
  
  object
  
  Email custom field value.
  
  type
  
  string
  
  required
  
  Always "email" for this field type.
  
  value
  
  string | null
  
  Email address or null.
  
  phone
  
  object
  
  Phone custom field value.
  
  type
  
  string
  
  required
  
  Always "phone" for this field type.
  
  value
  
  string | null
  
  Phone number or null.
  
  checkbox
  
  object
  
  Checkbox custom field value.
  
  type
  
  string
  
  required
  
  Always "checkbox" for this field type.
  
  value
  
  boolean | null
  
  Boolean value or null.
  
  relatedTo
  
  object
  
  Related task custom field value.
  
  type
  
  string
  
  required
  
  Always "relatedTo" for this field type.
  
  value
  
  string | null
  
  Related task ID or null.
- chunks
  
  array<object>
  
  Array of scheduling chunks for the task.
  id
  
  string
  
  The ID of the chunk.
  
  duration
  
  number
  
  The duration of the chunk in minutes.
  
  scheduledStart
  
  datetime
  
  The scheduled start time of the chunk.
  
  scheduledEnd
  
  datetime
  
  The scheduled end time of the chunk.
  
  completedTime
  
  datetime
  
  The time when the chunk was completed.
  
  isFixed
  
  boolean
  
  Whether the chunk is fixed or not.