A library for accessing the Shortcut.com V3 API

You can install this library using composer:

composer require kayrah87/shortcut-api

To use this library, you need to create a new instance of the ShortcutApi class:

$api = new kayrah87\Shortcut('YOUR_SHORTCUT_TOKEN');

You can then utilise this as follows:

Gets a list of all of the selected objects:

$api->get('object-name');

Gets a specific object:

$api->get('object-name', OBJECT_ID);

The list of objects can be found on the Shortcut.com API documentation. However, you may be able to guess most of them.

• stories
• epics
• iterations
• etc etc

Creates a new object:

$api->create('object-name', [
    // object fields
    ]);

Again, the specific object fields can be found on the Shortcut.com API documentation.

Updates an existing object:

$api->update('object-name', OBJECT_ID, [
    // object fields
    ]);

Deletes an existing object:

$api->delete('object-name', OBJECT_ID);

This library is licensed under the MIT license. Please see the LICENSE file for more information. Feel free to use this library in your own projects or to fork it. Thanks!

This library is open source. You can contribute by opening a pull request on Github.

Please report any bugs or issues to Github.