API Docs

List all Projects

Projects in Blue form the fundamental framework for organizing users and data.

List all projects in Company

query ProjectListQuery {
  projectList(filter: { companyIds: ["ENTER COMPANY ID"] }) {
    items {
      id
      uid
      slug
      name
      description
      archived
      color
      icon
      createdAt
      updatedAt
      allowNotification
      position
      unseenActivityCount
      todoListsMaxPosition
      lastAccessedAt
      isTemplate
      automationsCount
      totalFileCount
      totalFileSize
      todoAlias
    }
    pageInfo {
      totalPages
      totalItems
      page
      perPage
      hasNextPage
      hasPreviousPage
    }
  }
}

Project Fields

The following table describes the fields returned for each project in the ProjectListQuery:

FieldDescription
idUnique identifier for the project
uidUser-friendly unique identifier for the project
slugURL-friendly name of the project
nameDisplay name of the project
descriptionBrief description of the project
archivedBoolean indicating if the project is archived
colorColor associated with the project for visual identification
iconIcon associated with the project for visual identification
createdAtTimestamp when the project was created
updatedAtTimestamp when the project was last updated
allowNotificationBoolean indicating if notifications are enabled for the project
positionNumeric value representing the project's position in a list
unseenActivityCountNumber of unseen activities in the project
todoListsMaxPositionMaximum position value for todo lists in the project
lastAccessedAtTimestamp when the project was last accessed
isTemplateBoolean indicating if the project is a template
automationsCountNumber of automations associated with the project
totalFileCountTotal number of files in the project
totalFileSizeTotal size of all files in the project
todoAliasCustom alias for "todo" used in the project

Pagination Fields

The pageInfo object provides pagination details for the query results:

FieldDescription
totalPagesTotal number of pages of results
totalItemsTotal number of projects matching the query
pageCurrent page number
perPageNumber of items per page
hasNextPageBoolean indicating if there's a next page of results
hasPreviousPageBoolean indicating if there's a previous page of results