Package pw.chew.clickup4j.api.entities

Interface Workspace

All Known Implementing Classes:
WorkspaceImpl
public interface Workspace

Workspace

This is the highest level of organization in ClickUp.

  • Method Details

    • getId

      @NotNull @NotNull String getId()
      The ID of the workspace.
      Returns:
      The ID of the workspace.

    • getName

      @NotNull @NotNull String getName()
      The human-readable name of the Workspace.
      Returns:
      Never-null String containing the workspace's name.

    • getColor

      @NotNull @NotNull Color getColor()
      The color for this workspace.
      Returns:
      Never-null Color object containing the workspace's color.

    • getAvatar

      @Nullable @Nullable String getAvatar()
      The avatar or icon for this workspace.

      If the workspace does not have an avatar, this will be null.

      Returns:
      Nullable String containing the workspace's avatar.

    • getMembers

      @NotNull @NotNull List<Member> getMembers()
      Returns a list of all the members in this workspace.
      Returns:
      Never-null List of members in this workspace.

    • retrieveGoals

      @NotNull @NotNull Requester<List<Goal>> retrieveGoals()
      Retrieves a list of goals in this workspace.
      Returns:
      Never-null List of goals in this workspace.

    • getClickUp4j

      @NotNull @NotNull ClickUp4j getClickUp4j()
      Returns this ClickUp4j instance.
      Returns:
      Never-null ClickUp4j instance.