List all Workspaces

List all Workspaces

The projectList query allows you to retrieve workspaces with powerful filtering, sorting, and pagination options.

Basic Example

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
    }
  }
}

Advanced Example with Filtering and Sorting

query FilteredProjectList {
  projectList(
    filter: {
      companyIds: ["company-123", "company-456"]
      archived: false
      isTemplate: false
      search: "marketing"
      inProject: true
      folderId: null  # Get root-level projects only
    }
    sort: [position_ASC, name_ASC]
    skip: 0
    take: 50
  ) {
    items {
      id
      name
      slug
      position
      archived
    }
    totalCount
    pageInfo {
      totalItems
      hasNextPage
    }
  }
}

Workspace Fields

The following table describes all available fields for each workspace in the ProjectListQuery:

Note: You can request any combination of these fields in your GraphQL query.

Pagination Fields

The pageInfo object provides pagination details for the query results:

Query Parameters

Filter Options (ProjectListFilter)

Note on inProject filter:

• true or undefined: Returns workspaces the user is a member of
• false: Returns workspaces the user is NOT in (requires organization owner permission)
• Folder filtering (folderId) only works when inProject is not false

Sorting Options (ProjectSort)

*Position sorting is only available when viewing workspaces the user is a member of (inProject !== false)

Pagination Parameters

Important Notes

1. Default behavior for non-member workspaces (inProject: false):

   • Excludes archived workspaces unless archived filter is explicitly set
   • Excludes template workspaces unless isTemplate filter is explicitly set

2. Folder filtering limitations:

   • Only works when showing user’s workspaces
   • Cannot be used with inProject: false
   • Use folderId: null to get workspaces not in any folder

3. Sorting fallback:

   • Position sorting is ignored when viewing non-member workspaces
   • Falls back to name sorting in such cases

4. Deprecated parameters:

   • orderBy, after, before, first, last are deprecated
   • Use sort, skip, and take instead