|
1 |
| -[](https://github.com/FabianBeiner/Todoist-PHP-API-Library/tags) * [](https://github.com/FabianBeiner/Todoist-PHP-API-Library/stargazers) * [](https://github.com/FabianBeiner/Todoist-PHP-API-Library/issues) * [](https://github.com/FabianBeiner/Todoist-PHP-API-Library/blob/master/LICENSE) * [](https://www.codacy.com/app/FabianBeiner/Todoist-PHP-API-Library?utm_source=github.com&utm_medium=referral&utm_content=FabianBeiner/Todoist-PHP-API-Library&utm_campaign=Badge_Grade)# Todoist PHP API Library**This repository contains an _unofficial_ open source PHP client library that provides a native interface to the official [Todoist REST API](https://developer.todoist.com/rest/v8/) (v8).**## Requirements- [PHP](http://php.net/): >= 7.0- [guzzlehttp/guzzle](https://packagist.org/packages/guzzlehttp/guzzle): ~6.3## InstallationYou can either use [**Composer**](https://getcomposer.org/) or simply [**download the latest release**](https://github.com/FabianBeiner/Todoist-PHP-API-Library/releases) and do your stuff.### ComposerIf you don’t have Composer installed, follow the [installation instructions](https://getcomposer.org/doc/00-intro.md).Once composer is installed, execute the following command in your project root to install this library:```shcomposer require fabian-beiner/todoist-php-api-library```Finally, remember to include the autoloader to your project:```phprequire __DIR__ . '/vendor/autoload.php';```## Obtain your personal API token[Just click here](https://todoist.com/Users/viewPrefs?page=integrations). Or open the [Todoist web app](https://todoist.com), click on the gear icon , select “Settings”, then “Integrations”. Your API token is listed on the bottom of this page.## Usage```php$Todoist = new FabianBeiner\Todoist\Todoist('YOUR_API_TOKEN');```## Methods & Examples### [“Projects” methods and examples](https://github.com/FabianBeiner/Todoist-PHP-API-Library/wiki/Methods:-Projects#projects-methods-and-examples)* [Get all projects](https://github.com/FabianBeiner/Todoist-PHP-API-Library/wiki/Methods:-Projects#get-all-projects)* [Create a new project](https://github.com/FabianBeiner/Todoist-PHP-API-Library/wiki/Methods:-Projects#create-a-new-project)* [Get a project](https://github.com/FabianBeiner/Todoist-PHP-API-Library/wiki/Methods:-Projects#get-a-project)* [Update a project](https://github.com/FabianBeiner/Todoist-PHP-API-Library/wiki/Methods:-Projects#update-actually-rename-a-project)* [Delete a project](https://github.com/FabianBeiner/Todoist-PHP-API-Library/wiki/Methods:-Projects#delete-a-project)### [“Tasks” methods and examples](https://github.com/FabianBeiner/Todoist-PHP-API-Library/wiki/Methods:-Tasks)* [Get tasks](https://github.com/FabianBeiner/Todoist-PHP-API-Library/wiki/Methods:-Tasks)* [Create a new task](https://github.com/FabianBeiner/Todoist-PHP-API-Library/wiki/Methods:-Tasks)* [Get a task](https://github.com/FabianBeiner/Todoist-PHP-API-Library/wiki/Methods:-Tasks)* [Update a task](https://github.com/FabianBeiner/Todoist-PHP-API-Library/wiki/Methods:-Tasks)* [Close a task](https://github.com/FabianBeiner/Todoist-PHP-API-Library/wiki/Methods:-Tasks)* [Reopen a task](https://github.com/FabianBeiner/Todoist-PHP-API-Library/wiki/Methods:-Tasks)* [Delete a task](https://github.com/FabianBeiner/Todoist-PHP-API-Library/wiki/Methods:-Tasks)### [“Comments” methods and examples](https://github.com/FabianBeiner/Todoist-PHP-API-Library/wiki/Methods:-Comments#comments-methods-and-examples)* [Get all comments](https://github.com/FabianBeiner/Todoist-PHP-API-Library/wiki/Methods:-Comments#get-all-comments)* [Create a new comment](https://github.com/FabianBeiner/Todoist-PHP-API-Library/wiki/Methods:-Comments#create-a-new-comment)* [Get a comment](https://github.com/FabianBeiner/Todoist-PHP-API-Library/wiki/Methods:-Comments#get-a-comment)* [Update a comment](https://github.com/FabianBeiner/Todoist-PHP-API-Library/wiki/Methods:-Comments#update-a-comment)* [Delete a comment](https://github.com/FabianBeiner/Todoist-PHP-API-Library/wiki/Methods:-Comments#delete-a-comment)### [“Labels” methods and examples](https://github.com/FabianBeiner/Todoist-PHP-API-Library/wiki/Methods:-Labels#labels-methods-and-examples)* [Get all labels](https://github.com/FabianBeiner/Todoist-PHP-API-Library/wiki/Methods:-Labels#get-all-labels)* [Create a new label](https://github.com/FabianBeiner/Todoist-PHP-API-Library/wiki/Methods:-Labels#create-a-new-label)* [Get a label](https://github.com/FabianBeiner/Todoist-PHP-API-Library/wiki/Methods:-Labels#get-a-label)* [Update a label](https://github.com/FabianBeiner/Todoist-PHP-API-Library/wiki/Methods:-Labels#update-actually-rename-a-label)* [Delete a label](https://github.com/FabianBeiner/Todoist-PHP-API-Library/wiki/Methods:-Labels#delete-a-label)## ContributingI’d be happy if you contribute to this library. Please try to follow the existing coding style and use proper comments in your commit message. 🙏## LicensePlease see the [license file](https://github.com/FabianBeiner/Todoist-PHP-API-Library/blob/master/LICENSE) for more information. |
| 1 | +[](https://github.com/FabianBeiner/Todoist-PHP-API-Library/tags) * [](https://github.com/FabianBeiner/Todoist-PHP-API-Library/stargazers) * [](https://github.com/FabianBeiner/Todoist-PHP-API-Library/issues) * [](https://github.com/FabianBeiner/Todoist-PHP-API-Library/blob/master/LICENSE) * [](https://www.codacy.com/app/FabianBeiner/Todoist-PHP-API-Library?utm_source=github.com&utm_medium=referral&utm_content=FabianBeiner/Todoist-PHP-API-Library&utm_campaign=Badge_Grade) * [](https://styleci.io/repos/28313097/) |
| 2 | + |
| 3 | +# Todoist PHP API Library |
| 4 | + |
| 5 | +**This repository contains an _unofficial_ open source PHP client library that provides a native interface to the official [Todoist REST API](https://developer.todoist.com/rest/v8/) (v8).** |
| 6 | + |
| 7 | +## Requirements |
| 8 | +- [PHP](http://php.net/): >= 7.0 |
| 9 | +- [guzzlehttp/guzzle](https://packagist.org/packages/guzzlehttp/guzzle): ~6.3 |
| 10 | + |
| 11 | +## Installation |
| 12 | + |
| 13 | +You can either use [**Composer**](https://getcomposer.org/) or simply [**download the latest release**](https://github.com/FabianBeiner/Todoist-PHP-API-Library/releases) and do your stuff. |
| 14 | + |
| 15 | +### Composer |
| 16 | + |
| 17 | +If you don’t have Composer installed, follow the [installation instructions](https://getcomposer.org/doc/00-intro.md). |
| 18 | + |
| 19 | +Once composer is installed, execute the following command in your project root to install this library: |
| 20 | + |
| 21 | +```sh |
| 22 | +composer require fabian-beiner/todoist-php-api-library |
| 23 | +``` |
| 24 | + |
| 25 | +Finally, remember to include the autoloader to your project: |
| 26 | + |
| 27 | +```php |
| 28 | +require __DIR__ . '/vendor/autoload.php'; |
| 29 | +``` |
| 30 | + |
| 31 | +## Obtain your personal API token |
| 32 | +[Just click here](https://todoist.com/Users/viewPrefs?page=integrations). Or open the [Todoist web app](https://todoist.com), click on the gear icon , select “Settings”, then “Integrations”. Your API token is listed on the bottom of this page. |
| 33 | + |
| 34 | +## Usage |
| 35 | +```php |
| 36 | +$Todoist = new FabianBeiner\Todoist\Todoist('YOUR_API_TOKEN'); |
| 37 | +``` |
| 38 | + |
| 39 | +## Methods & Examples |
| 40 | + |
| 41 | +### [“Projects” methods and examples](https://github.com/FabianBeiner/Todoist-PHP-API-Library/wiki/Methods:-Projects#projects-methods-and-examples) |
| 42 | + |
| 43 | +* [Get all projects](https://github.com/FabianBeiner/Todoist-PHP-API-Library/wiki/Methods:-Projects#get-all-projects) |
| 44 | +* [Create a new project](https://github.com/FabianBeiner/Todoist-PHP-API-Library/wiki/Methods:-Projects#create-a-new-project) |
| 45 | +* [Get a project](https://github.com/FabianBeiner/Todoist-PHP-API-Library/wiki/Methods:-Projects#get-a-project) |
| 46 | +* [Update a project](https://github.com/FabianBeiner/Todoist-PHP-API-Library/wiki/Methods:-Projects#update-actually-rename-a-project) |
| 47 | +* [Delete a project](https://github.com/FabianBeiner/Todoist-PHP-API-Library/wiki/Methods:-Projects#delete-a-project) |
| 48 | + |
| 49 | +### [“Tasks” methods and examples](https://github.com/FabianBeiner/Todoist-PHP-API-Library/wiki/Methods:-Tasks) |
| 50 | + |
| 51 | +* [Get tasks](https://github.com/FabianBeiner/Todoist-PHP-API-Library/wiki/Methods:-Tasks) |
| 52 | +* [Create a new task](https://github.com/FabianBeiner/Todoist-PHP-API-Library/wiki/Methods:-Tasks) |
| 53 | +* [Get a task](https://github.com/FabianBeiner/Todoist-PHP-API-Library/wiki/Methods:-Tasks) |
| 54 | +* [Update a task](https://github.com/FabianBeiner/Todoist-PHP-API-Library/wiki/Methods:-Tasks) |
| 55 | +* [Close a task](https://github.com/FabianBeiner/Todoist-PHP-API-Library/wiki/Methods:-Tasks) |
| 56 | +* [Reopen a task](https://github.com/FabianBeiner/Todoist-PHP-API-Library/wiki/Methods:-Tasks) |
| 57 | +* [Delete a task](https://github.com/FabianBeiner/Todoist-PHP-API-Library/wiki/Methods:-Tasks) |
| 58 | + |
| 59 | +### [“Comments” methods and examples](https://github.com/FabianBeiner/Todoist-PHP-API-Library/wiki/Methods:-Comments#comments-methods-and-examples) |
| 60 | + |
| 61 | +* [Get all comments](https://github.com/FabianBeiner/Todoist-PHP-API-Library/wiki/Methods:-Comments#get-all-comments) |
| 62 | +* [Create a new comment](https://github.com/FabianBeiner/Todoist-PHP-API-Library/wiki/Methods:-Comments#create-a-new-comment) |
| 63 | +* [Get a comment](https://github.com/FabianBeiner/Todoist-PHP-API-Library/wiki/Methods:-Comments#get-a-comment) |
| 64 | +* [Update a comment](https://github.com/FabianBeiner/Todoist-PHP-API-Library/wiki/Methods:-Comments#update-a-comment) |
| 65 | +* [Delete a comment](https://github.com/FabianBeiner/Todoist-PHP-API-Library/wiki/Methods:-Comments#delete-a-comment) |
| 66 | + |
| 67 | +### [“Labels” methods and examples](https://github.com/FabianBeiner/Todoist-PHP-API-Library/wiki/Methods:-Labels#labels-methods-and-examples) |
| 68 | + |
| 69 | +* [Get all labels](https://github.com/FabianBeiner/Todoist-PHP-API-Library/wiki/Methods:-Labels#get-all-labels) |
| 70 | +* [Create a new label](https://github.com/FabianBeiner/Todoist-PHP-API-Library/wiki/Methods:-Labels#create-a-new-label) |
| 71 | +* [Get a label](https://github.com/FabianBeiner/Todoist-PHP-API-Library/wiki/Methods:-Labels#get-a-label) |
| 72 | +* [Update a label](https://github.com/FabianBeiner/Todoist-PHP-API-Library/wiki/Methods:-Labels#update-actually-rename-a-label) |
| 73 | +* [Delete a label](https://github.com/FabianBeiner/Todoist-PHP-API-Library/wiki/Methods:-Labels#delete-a-label) |
| 74 | + |
| 75 | +## Contributing |
| 76 | +I’d be happy if you contribute to this library. Please try to follow the existing coding style and use proper comments in your commit message. 🙏 |
| 77 | + |
| 78 | +## License |
| 79 | + |
| 80 | +Please see the [license file](https://github.com/FabianBeiner/Todoist-PHP-API-Library/blob/master/LICENSE) for more information. |
0 commit comments