PHP download

Download the PHP package buzkall/laravel-ticktick without Composer

On this page you can find all versions of the php package buzkall/laravel-ticktick. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

Table of contents
Download buzkall/laravel-ticktick
More information about buzkall/laravel-ticktick
Files in buzkall/laravel-ticktick

Vendor buzkall
Package laravel-ticktick
Short Description A Laravel package to connect to TickTick API and manage tasks
License MIT
Homepage https://github.com/buzkall/ticktick

Keywords api laravel task management productivity ticktick

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:

If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.

Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
To use Composer is sometimes complicated. Especially for beginners.
Composer needs much resources. Sometimes they are not available on a simple webspace.
If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.

Please rate this library. Is it a good library?

Example code of buzkall/laravel-ticktick

Informations about the package laravel-ticktick

TickTick Laravel Package

A Laravel package to connect to the TickTick API, authenticate, and interact with tasks. Built using the Spatie package skeleton structure.

Features

🔐 OAuth2 authentication: authorization code, PKCE, or a personal API token
✅ Full Open API v1 coverage: tasks, projects, groups, columns, tags, habits, focus and countdowns
🔎 Server-side task search and filtering
🎯 Task completion tracking
🚀 Laravel service provider and facade
✨ Clean and intuitive API
🔄 Refresh token support
🧪 Test suite covering the HTTP layer

Requirements

PHP 8.4 or higher
Laravel 12 or 13

Installation

You can install the package via Composer:

Publish the configuration file:

Configuration

Add your TickTick API credentials to your .env file:

To obtain API credentials:

Visit TickTick Developer Portal
Create a new application
Copy your Client ID and Client Secret

Usage

The API documentation is here: https://developer.ticktick.com/docs#/openapi

Authentication

Three options, simplest first.

Option A: Personal API token (no OAuth)

The quickest way to get going, and the only one that works in a headless environment. In the TickTick web app click your avatar, then Settings → Account → API Token, and create a token.

That token is sent exactly like an OAuth access token, so every method in this package works with it and there is no browser round trip to arrange. This is the same mechanism the official TickTick CLI uses for ticktick auth token <token>.

Option B: OAuth with PKCE (no client secret)

PKCE suits public clients that cannot keep a secret. Generate a verifier before redirecting, keep it in the session, and send it back on the callback.

Option C: OAuth authorization code (with client secret)

Step 1: Redirect user to TickTick authorization page

The client id, redirect uri and scope default to the values in config/ticktick.php, so you only need to pass them to override the defaults.

If a random state is not provided, one is generated for you. Store it in the session so you can verify it in the callback.

Step 2: Handle the callback

Step 3: Refresh the access token when it expires

The refresh token also defaults to config('ticktick.refresh_token'), so TickTick::refreshAccessToken() works without arguments when it is configured.

Working with Projects

Get all projects

Get a specific project

Get project data (including tasks)

Working with Tasks

Get all tasks for a project

Filter tasks by date

Create a new task

Get a specific task

Update a task

Delete a task

Complete a task

Searching and filtering tasks

TickTick can filter server-side, which avoids pulling a whole project down.

Note that today() and byDueDate() still filter client-side, since the API has no single-day due-date filter; search() with dueFrom/dueTo is the server-side equivalent for a range.

Moving tasks and comments

Managing projects, groups and columns

Tags, habits, focus and countdowns

Field formats

Field	Values
`priority`	`0` none, `1` low, `3` medium, `5` high
`status`	`0` open, `-1` abandoned, `2` completed
`viewMode`	`list`, `kanban`, `timeline`
`kind`	`TASK`, `NOTE`, `CHECKLIST`
`reminders[]`	`TRIGGER(;RELATED=START\\|END)?:(-)?P…` e.g. `TRIGGER:-PT60M`, `TRIGGER;RELATED=END:-PT15M`
`repeatFlag`	A single `RRULE:` or `ERULE:` string, never both
Focus `type`	`0` pomodoro, `1` timing
Habit check-in `stamp`	`Ymd`, e.g. `20260407`

Using without Facade

Using Dependency Injection

API Reference

Authentication Methods

All arguments except $code and $state fall back to config/ticktick.php.

getAuthorizationUrl($clientId = null, $redirectUri = null, $scope = null, $state = '', $codeChallenge = null) - Generate authorization URL; pass a challenge for PKCE
generatePkceChallenge() - Returns ['code_verifier' => …, 'code_challenge' => …] (S256)
getAccessTokenFromPkceCode($code, $codeVerifier, $clientId = null, $redirectUri = null, $scope = null) - Exchange a PKCE code, no client secret sent
getAccessTokenFromCode($code, $clientId = null, $clientSecret = null, $redirectUri = null, $scope = null) - Exchange authorization code for access token
refreshAccessToken($refreshToken = null, $clientId = null, $clientSecret = null, $scope = null) - Exchange a refresh token for a new access token
setAccessToken($token) / getAccessToken() - Set or read the access token used for API requests
setRefreshToken($token) / getRefreshToken() - Set or read the refresh token

Project Methods

projects()->all($params = []) - Get all projects
projects()->get($projectId) - Get a specific project
projects()->getData($projectId) - Get project data including all tasks and columns
projects()->create($data) - Create a project
projects()->update($projectId, $data) - Update a project
projects()->delete($projectId) - Delete a project

Project Group Methods

projectGroups()->all() / create($data) / update($groupId, $data) / delete($groupId)

Column Methods

columns()->all($projectId) / create($projectId, $data) / update($projectId, $columnId, $data)

Task Methods

tasks()->all($projectId, $params = []) - Get all tasks for a specific project
tasks()->today($projectId, $timezone = null, $params = []) - Get tasks due today (client-side filtering)
tasks()->byDueDate($projectId, $date, $timezone = null, $params = []) - Get tasks by due date in Y-m-d format (client-side filtering)
tasks()->get($taskId, $projectId) - Get a specific task
tasks()->create($data) - Create a new task
tasks()->update($taskId, $projectId, $data) - Update a task
tasks()->delete($taskId, $projectId) - Delete a task
tasks()->complete($taskId, $projectId) - Mark task as complete
tasks()->move($moves) / moveTask($taskId, $from, $to) - Move tasks between projects
tasks()->completed($projectIds, $startDate, $endDate) - Completed tasks in a range
tasks()->filter($projectIds, $startDate, $endDate, $priority, $tag, $status) - Server-side filter
tasks()->search($keywords, $projectIds, $tags, $status, $dueFrom, $dueTo) - Server-side search
tasks()->comments($taskId, $projectId) / addComment(...) / deleteComment(...)

Tag Methods

tags()->all() / create($data)

Habit Methods

habits()->all() / get($habitId) / create($data) / update($habitId, $data)
habits()->checkin($habitId, $data) / checkins($habitIds, $from, $to)

Focus Methods

focus()->all($from, $to, $type) / get($focusId, $type) / create($data) / delete($focusId, $type)

Countdown Methods

countdowns()->all()

Error handling

Every failure is thrown as a Arzcode\TickTick\Exceptions\TickTickException, including connection failures and unparseable responses. When TickTick answered with an HTTP error, the status code and raw body are available on the exception:

Testing

Run the tests with:

The suite mocks the Guzzle handler, so it asserts the exact requests the package sends to TickTick without hitting the network.

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

If you discover any security-related issues, please email the maintainer instead of using the issue tracker.

Credits

buzkall

License

The MIT License (MIT). Please see License File for more information.

All versions of laravel-ticktick with dependencies

PHP Build Version

Package Version

Version 0.0.1 Release 08. Nov 2025
create-project require 0 people chose require and
0 people chose create-project.

Download

Download latest version of laravel-ticktick from vendor buzkall

Requires php Version ^8.2
guzzlehttp/guzzle Version ^7.5
illuminate/support Version ^11.0|^12.0

Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package buzkall/laravel-ticktick contains the following files

Loading the files please wait ...