Git Product home page Git Product logo

clickupapi's Introduction

Build Status Contributors Forks Stargazers Issues MIT License


Logo

ClickUpAPI

An unofficial .NET wrapper for the ClickUp V2 API.

Quickstart Guide · Report Bug · Request Feature


Getting Started

Follow the steps below to install and use this library.

Prerequisites

  • .NET SDK

  • ClickUp Personal Token or OAuth2 Credentials

    The ClickUp API requires authentication, so you will need credentials to use this library. Visit the ClickUp authentication documentation for more info.

Installation

All you have to do is install the NuGet package into your project!

dotnet add package BIOS9.ClickUp

(back to top)

Usage

Replace the API key values in these examples with your own.

Reading from the API

var apiKey = "pk_1234567_ABCDEFGHIJKLMNOPQRSTUVWXYZ12345"
var client = new ClickUpClient(apiKey);

// Get all teams that are accessible with the current API key.
var teams = await client.GetAuthorizedTeamsAsync();
Console.WriteLine("Team: " + teams.First().Name);

// Get spaces within the first team.
var spaces = await teams.First().GetSpacesAsync();

// Get folders within the first space
var folders = await spaces.First().GetFoldersAsync();

// etc... Refer to the ClickUp structure diagram below for more info on which objects you can get from the API.

Creating stuff

var apiKey = "pk_1234567_ABCDEFGHIJKLMNOPQRSTUVWXYZ12345"
var client = new ClickUpClient(apiKey);

// Get team to create space in.
var myCoolTeam = await client.GetAuthorizedTeamsAsync().First();

// Create space with a name.
var mySpace = await myCoolTeam.CreateSpaceAsync(p =>
{
    p.Name = "My brand new space";
});

Console.WriteLine(mySpace.Id);
Console.WriteLine(mySpace.Name);

Modifying existing stuff

var apiKey = "pk_1234567_ABCDEFGHIJKLMNOPQRSTUVWXYZ12345"
var client = new ClickUpClient(apiKey);

// Get first space in the first team.
var team = await client.GetAuthorizedTeamsAsync().First();
var mySpace = await client.GetAuthorizedTeamsAsync().First();

// Change the name of the space
await mySpace.ModifyAsync(p =>
{
    p.Name = "Replacement name";
});

// The mySpace object will also have it's name updated
Console.WriteLine(mySpace.Name);

ClickUp Object Structure

ClickUp uses the following simplified layout for objects, and this library aims to mimic it.

graph TD;
    Teams-->Spaces;
    Spaces-->Folders;
    Spaces-->Lists;
    Folders-->Lists;
    Lists-->Tasks;
Loading

(back to top)

License

Distributed under the MIT License. See LICENSE.md for more information.

(back to top)

Acknowledgments

(back to top)

clickupapi's People

Contributors

bios9 avatar renovate[bot] avatar

Stargazers

 avatar

Watchers

 avatar

clickupapi's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

Detected dependencies

github-actions
.github/workflows/main.yml
  • actions/checkout v4
  • actions/setup-dotnet v3.2.0
  • actions/checkout v4
  • actions/setup-dotnet v3.2.0
nuget
BIOS9.ClickUp/BIOS9.ClickUp/BIOS9.ClickUp.csproj
  • RestSharp 110.2.0
  • Newtonsoft.Json 13.0.3

  • Check this box to trigger a request for Renovate to run again on this repository

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.