timetoreply/shortcut

Shortcut API

Maintainers

Details

github.com/timetoreply/shortcut

Homepage

Source

Issues

Installs: 5

Dependents: 0

Suggesters: 0

Security: 0

Stars: 1

Watchers: 0

Forks: 0

Open Issues: 0

pkg:composer/timetoreply/shortcut

0.4.0 2025-07-01 08:49 UTC

Requires

Requires (Dev)

proprietary 15950d40a0e94672267310894523310dde19fd39

phprestapisdkopenapiopenapitoolsopenapi-generator

This package is not auto-updated.

Last update: 2025-10-21 10:21:45 UTC

README

Shortcut API

Installation & Usage

Requirements

PHP 8.1 and later.

Installation

The library can be installed via Composer:

composer require timetoreply/shortcut

Then run composer install

Getting Started

Please follow the installation procedure and then run the following:

// Configure API key authorization: api_token
$config = Timetoreply\Shortcut\Configuration::getDefaultConfiguration()->setApiKey('Shortcut-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Timetoreply\Shortcut\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Shortcut-Token', 'Bearer');


$apiInstance = new Timetoreply\Shortcut\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$createCategory = new \Timetoreply\Shortcut\Model\CreateCategory(); // \Timetoreply\Shortcut\Model\CreateCategory

try {
    $result = $apiInstance->createCategory($createCategory);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->createCategory: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://api.app.shortcut.com

Class Method HTTP request Description
DefaultApi createCategory POST /api/v3/categories Create Category
DefaultApi createDoc POST /api/v3/documents Create Doc
DefaultApi createEntityTemplate POST /api/v3/entity-templates Create Entity Template
DefaultApi createEpic POST /api/v3/epics Create Epic
DefaultApi createEpicComment POST /api/v3/epics/{epic-public-id}/comments Create Epic Comment
DefaultApi createEpicCommentComment POST /api/v3/epics/{epic-public-id}/comments/{comment-public-id} Create Epic Comment Comment
DefaultApi createEpicHealth POST /api/v3/epics/{epic-public-id}/health Create Epic Health
DefaultApi createGenericIntegration POST /api/v3/integrations/webhook Create Generic Integration
DefaultApi createGroup POST /api/v3/groups Create Group
DefaultApi createIteration POST /api/v3/iterations Create Iteration
DefaultApi createLabel POST /api/v3/labels Create Label
DefaultApi createLinkedFile POST /api/v3/linked-files Create Linked File
DefaultApi createMilestone POST /api/v3/milestones Create Milestone
DefaultApi createMultipleStories POST /api/v3/stories/bulk Create Multiple Stories
DefaultApi createObjective POST /api/v3/objectives Create Objective
DefaultApi createProject POST /api/v3/projects Create Project
DefaultApi createStory POST /api/v3/stories Create Story
DefaultApi createStoryComment POST /api/v3/stories/{story-public-id}/comments Create Story Comment
DefaultApi createStoryFromTemplate POST /api/v3/stories/from-template Create Story From Template
DefaultApi createStoryLink POST /api/v3/story-links Create Story Link
DefaultApi createStoryReaction POST /api/v3/stories/{story-public-id}/comments/{comment-public-id}/reactions Create Story Reaction
DefaultApi createTask POST /api/v3/stories/{story-public-id}/tasks Create Task
DefaultApi deleteCategory DELETE /api/v3/categories/{category-public-id} Delete Category
DefaultApi deleteCustomField DELETE /api/v3/custom-fields/{custom-field-public-id} Delete Custom Field
DefaultApi deleteEntityTemplate DELETE /api/v3/entity-templates/{entity-template-public-id} Delete Entity Template
DefaultApi deleteEpic DELETE /api/v3/epics/{epic-public-id} Delete Epic
DefaultApi deleteEpicComment DELETE /api/v3/epics/{epic-public-id}/comments/{comment-public-id} Delete Epic Comment
DefaultApi deleteFile DELETE /api/v3/files/{file-public-id} Delete File
DefaultApi deleteGenericIntegration DELETE /api/v3/integrations/webhook/{integration-public-id} Delete Generic Integration
DefaultApi deleteIteration DELETE /api/v3/iterations/{iteration-public-id} Delete Iteration
DefaultApi deleteLabel DELETE /api/v3/labels/{label-public-id} Delete Label
DefaultApi deleteLinkedFile DELETE /api/v3/linked-files/{linked-file-public-id} Delete Linked File
DefaultApi deleteMilestone DELETE /api/v3/milestones/{milestone-public-id} Delete Milestone
DefaultApi deleteMultipleStories DELETE /api/v3/stories/bulk Delete Multiple Stories
DefaultApi deleteObjective DELETE /api/v3/objectives/{objective-public-id} Delete Objective
DefaultApi deleteProject DELETE /api/v3/projects/{project-public-id} Delete Project
DefaultApi deleteStory DELETE /api/v3/stories/{story-public-id} Delete Story
DefaultApi deleteStoryComment DELETE /api/v3/stories/{story-public-id}/comments/{comment-public-id} Delete Story Comment
DefaultApi deleteStoryLink DELETE /api/v3/story-links/{story-link-public-id} Delete Story Link
DefaultApi deleteStoryReaction DELETE /api/v3/stories/{story-public-id}/comments/{comment-public-id}/reactions Delete Story Reaction
DefaultApi deleteTask DELETE /api/v3/stories/{story-public-id}/tasks/{task-public-id} Delete Task
DefaultApi disableIterations PUT /api/v3/iterations/disable Disable Iterations
DefaultApi disableStoryTemplates PUT /api/v3/entity-templates/disable Disable Story Templates
DefaultApi enableIterations PUT /api/v3/iterations/enable Enable Iterations
DefaultApi enableStoryTemplates PUT /api/v3/entity-templates/enable Enable Story Templates
DefaultApi getCategory GET /api/v3/categories/{category-public-id} Get Category
DefaultApi getCurrentMemberInfo GET /api/v3/member Get Current Member Info
DefaultApi getCustomField GET /api/v3/custom-fields/{custom-field-public-id} Get Custom Field
DefaultApi getEntityTemplate GET /api/v3/entity-templates/{entity-template-public-id} Get Entity Template
DefaultApi getEpic GET /api/v3/epics/{epic-public-id} Get Epic
DefaultApi getEpicComment GET /api/v3/epics/{epic-public-id}/comments/{comment-public-id} Get Epic Comment
DefaultApi getEpicHealth GET /api/v3/epics/{epic-public-id}/health Get Epic Health
DefaultApi getEpicWorkflow GET /api/v3/epic-workflow Get Epic Workflow
DefaultApi getExternalLinkStories GET /api/v3/external-link/stories Get External Link Stories
DefaultApi getFile GET /api/v3/files/{file-public-id} Get File
DefaultApi getGenericIntegration GET /api/v3/integrations/webhook/{integration-public-id} Get Generic Integration
DefaultApi getGroup GET /api/v3/groups/{group-public-id} Get Group
DefaultApi getIteration GET /api/v3/iterations/{iteration-public-id} Get Iteration
DefaultApi getKeyResult GET /api/v3/key-results/{key-result-public-id} Get Key Result
DefaultApi getLabel GET /api/v3/labels/{label-public-id} Get Label
DefaultApi getLinkedFile GET /api/v3/linked-files/{linked-file-public-id} Get Linked File
DefaultApi getMember GET /api/v3/members/{member-public-id} Get Member
DefaultApi getMilestone GET /api/v3/milestones/{milestone-public-id} Get Milestone
DefaultApi getObjective GET /api/v3/objectives/{objective-public-id} Get Objective
DefaultApi getProject GET /api/v3/projects/{project-public-id} Get Project
DefaultApi getRepository GET /api/v3/repositories/{repo-public-id} Get Repository
DefaultApi getStory GET /api/v3/stories/{story-public-id} Get Story
DefaultApi getStoryComment GET /api/v3/stories/{story-public-id}/comments/{comment-public-id} Get Story Comment
DefaultApi getStoryLink GET /api/v3/story-links/{story-link-public-id} Get Story Link
DefaultApi getTask GET /api/v3/stories/{story-public-id}/tasks/{task-public-id} Get Task
DefaultApi getWorkflow GET /api/v3/workflows/{workflow-public-id} Get Workflow
DefaultApi listCategories GET /api/v3/categories List Categories
DefaultApi listCategoryMilestones GET /api/v3/categories/{category-public-id}/milestones List Category Milestones
DefaultApi listCategoryObjectives GET /api/v3/categories/{category-public-id}/objectives List Category Objectives
DefaultApi listCustomFields GET /api/v3/custom-fields List Custom Fields
DefaultApi listDocs GET /api/v3/documents List Docs
DefaultApi listEntityTemplates GET /api/v3/entity-templates List Entity Templates
DefaultApi listEpicComments GET /api/v3/epics/{epic-public-id}/comments List Epic Comments
DefaultApi listEpicHealths GET /api/v3/epics/{epic-public-id}/health-history List Epic Healths
DefaultApi listEpicStories GET /api/v3/epics/{epic-public-id}/stories List Epic Stories
DefaultApi listEpics GET /api/v3/epics List Epics
DefaultApi listEpicsPaginated GET /api/v3/epics/paginated List Epics Paginated
DefaultApi listFiles GET /api/v3/files List Files
DefaultApi listGroupStories GET /api/v3/groups/{group-public-id}/stories List Group Stories
DefaultApi listGroups GET /api/v3/groups List Groups
DefaultApi listIterationStories GET /api/v3/iterations/{iteration-public-id}/stories List Iteration Stories
DefaultApi listIterations GET /api/v3/iterations List Iterations
DefaultApi listLabelEpics GET /api/v3/labels/{label-public-id}/epics List Label Epics
DefaultApi listLabelStories GET /api/v3/labels/{label-public-id}/stories List Label Stories
DefaultApi listLabels GET /api/v3/labels List Labels
DefaultApi listLinkedFiles GET /api/v3/linked-files List Linked Files
DefaultApi listMembers GET /api/v3/members List Members
DefaultApi listMilestoneEpics GET /api/v3/milestones/{milestone-public-id}/epics List Milestone Epics
DefaultApi listMilestones GET /api/v3/milestones List Milestones
DefaultApi listObjectiveEpics GET /api/v3/objectives/{objective-public-id}/epics List Objective Epics
DefaultApi listObjectives GET /api/v3/objectives List Objectives
DefaultApi listProjects GET /api/v3/projects List Projects
DefaultApi listRepositories GET /api/v3/repositories List Repositories
DefaultApi listStories GET /api/v3/projects/{project-public-id}/stories List Stories
DefaultApi listStoryComment GET /api/v3/stories/{story-public-id}/comments List Story Comment
DefaultApi listWorkflows GET /api/v3/workflows List Workflows
DefaultApi search GET /api/v3/search Search
DefaultApi searchEpics GET /api/v3/search/epics Search Epics
DefaultApi searchIterations GET /api/v3/search/iterations Search Iterations
DefaultApi searchMilestones GET /api/v3/search/milestones Search Milestones
DefaultApi searchObjectives GET /api/v3/search/objectives Search Objectives
DefaultApi searchStories GET /api/v3/search/stories Search Stories
DefaultApi searchStoriesOld POST /api/v3/stories/search Search Stories (Old)
DefaultApi storyHistory GET /api/v3/stories/{story-public-id}/history Story History
DefaultApi unlinkCommentThreadFromSlack POST /api/v3/stories/{story-public-id}/comments/{comment-public-id}/unlink-from-slack Unlink Comment thread from Slack
DefaultApi unlinkProductboardFromEpic POST /api/v3/epics/{epic-public-id}/unlink-productboard Unlink Productboard from Epic
DefaultApi updateCategory PUT /api/v3/categories/{category-public-id} Update Category
DefaultApi updateCustomField PUT /api/v3/custom-fields/{custom-field-public-id} Update Custom Field
DefaultApi updateEntityTemplate PUT /api/v3/entity-templates/{entity-template-public-id} Update Entity Template
DefaultApi updateEpic PUT /api/v3/epics/{epic-public-id} Update Epic
DefaultApi updateEpicComment PUT /api/v3/epics/{epic-public-id}/comments/{comment-public-id} Update Epic Comment
DefaultApi updateFile PUT /api/v3/files/{file-public-id} Update File
DefaultApi updateGroup PUT /api/v3/groups/{group-public-id} Update Group
DefaultApi updateHealth PUT /api/v3/health/{health-public-id} Update Health
DefaultApi updateIteration PUT /api/v3/iterations/{iteration-public-id} Update Iteration
DefaultApi updateKeyResult PUT /api/v3/key-results/{key-result-public-id} Update Key Result
DefaultApi updateLabel PUT /api/v3/labels/{label-public-id} Update Label
DefaultApi updateLinkedFile PUT /api/v3/linked-files/{linked-file-public-id} Update Linked File
DefaultApi updateMilestone PUT /api/v3/milestones/{milestone-public-id} Update Milestone
DefaultApi updateMultipleStories PUT /api/v3/stories/bulk Update Multiple Stories
DefaultApi updateObjective PUT /api/v3/objectives/{objective-public-id} Update Objective
DefaultApi updateProject PUT /api/v3/projects/{project-public-id} Update Project
DefaultApi updateStory PUT /api/v3/stories/{story-public-id} Update Story
DefaultApi updateStoryComment PUT /api/v3/stories/{story-public-id}/comments/{comment-public-id} Update Story Comment
DefaultApi updateStoryLink PUT /api/v3/story-links/{story-link-public-id} Update Story Link
DefaultApi updateTask PUT /api/v3/stories/{story-public-id}/tasks/{task-public-id} Update Task
DefaultApi uploadFiles POST /api/v3/files Upload Files

Models

Authorization

Authentication schemes defined for the API:

api_token

  • Type: API key
  • API key parameter name: Shortcut-Token
  • Location: HTTP header

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

  • API version: 3.0
    • Package version: 0.4.0
    • Generator version: 7.14.0
  • Build package: org.openapitools.codegen.languages.PhpClientCodegen