List projects

Get all projects for a workspace.

GET

/ v1 / projects

Authorization

X-API-Key

string

required

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

Query parameters

cursor

string

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

string

The workspace for which all projects should be returned.

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.
projects

array<object>

The projects returned.
- 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.