Class Client

Index

Constructors

Properties

customFields epics iterations keyResults labels linkedFiles members objectives repositories shortcutApiKey stories teams uploadedFiles workflows baseUrl

Accessors

Constructors

constructor

new Client(shortcutApiKey?): Client
Parameters
- Optional shortcutApiKey: string
Returns Client
- Defined in client.ts:52

Properties

customFields

customFields: CustomFieldsService

epics

epics: EpicsService

iterations

iterations: IterationsService

keyResults

keyResults: KeyResultsService

labels

labels: LabelsService

linkedFiles

linkedFiles: LinkedFilesService

members

members: MembersService

objectives

objectives: ObjectivesService

repositories

repositories: RepositoriesService

`Private` `Readonly` shortcutApiKey

shortcutApiKey: undefined | string

stories

stories: StoriesService

teams

teams: TeamsService

uploadedFiles

uploadedFiles: UploadedFilesService

workflows

workflows: WorkflowsService

`Static` baseUrl

baseUrl: string = 'https://api.app.shortcut.com/api/v3'

Accessors

headers

get headers(): ShortcutHeaders
Returns ShortcutHeaders
- Defined in client.ts:20