PHPackages                             phuongnamdang/laravel-backlog-api - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. phuongnamdang/laravel-backlog-api

ActiveLibrary[API Development](/categories/api)

phuongnamdang/laravel-backlog-api
=================================

Backlog API Library for Laravel

v0.1.0(5y ago)22.7k↑100%MITPHP

Since Mar 16Pushed 5y ago1 watchersCompare

[ Source](https://github.com/PhuongNamDang/laravel-backlog-api)[ Packagist](https://packagist.org/packages/phuongnamdang/laravel-backlog-api)[ RSS](/packages/phuongnamdang-laravel-backlog-api/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (1)Dependencies (4)Versions (2)Used By (0)

Backlog API Library for Laravel
===============================

[](#backlog-api-library-for-laravel)

[![Build Status](https://camo.githubusercontent.com/13ca55c34c1c2d1b3f718efa83d598894d8db6a7ed6f2ef3b67cc66c6cc660ff/68747470733a2f2f7472617669732d63692e6f72672f697469676f70706f2f6261636b6c6f672d6170692e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/itigoppo/backlog-api)

This package was made for Laravel

BacklogAPIのPHPライブラリです。

- Backlog
- Backlog API version 2
    -

Source
======

[](#source)

Original source from

Requirements
============

[](#requirements)

- PHP ^7.2.5 || ^8.0

Contents
========

[](#contents)

- [Installation](#installation)

Installation
============

[](#installation)

```
composer require phuongnamdang/laravel-backlog-api
```

Usage
=====

[](#usage)

Setting .env

BACKLOG\_SPACE=companyname BACKLOG\_SECRET=apisecretkey BACKLOG\_DOMAIN=jp or com

Sample
------

[](#sample)

```
namespace App\Http\Controllers;

use Itigoppo\BacklogApi\Backlog\Backlog;

class BacklogController extends Controller
{
    public function index(Backlog $backlog) {
        dump(app('backlog')->users->myself());
        dump(\BacklogApi::statuses());
        dump($backlog->users->myself());
        dd($backlog->projects->load());
    }
}
```

For older Laravel version
-------------------------

[](#for-older-laravel-version)

Please update app.php for providers and aliases

```
'providers' => [
    Itigoppo\BacklogApi\Providers\LaravelServiceProvider::class,
],
'aliases' => [
    'BacklogApi' => Itigoppo\BacklogApi\Facades\Backlog::class,
]
```

Original document below
=======================

[](#original-document-below)

$domain部分、お使いのスペースに合わせて変更してください。 デフォルトは「jp」です。

状態一覧の取得
-------

[](#状態一覧の取得)

```
$backlog->statuses();
```

完了理由一覧の取得
---------

[](#完了理由一覧の取得)

```
$backlog->resolutions();
```

優先度一覧の取得
--------

[](#優先度一覧の取得)

```
$backlog->priorities();
```

スターの追加
------

[](#スターの追加)

```
$backlog->addStar([array $form_options = []]);
```

リクエストパラメータは以下参照

Space
-----

[](#space)

### スペース情報の取得

[](#スペース情報の取得)

```
$backlog->space->info();
```

### 最近の更新の取得

[](#最近の更新の取得)

```
$backlog->space->notification();
```

### スペースのお知らせの取得

[](#スペースのお知らせの取得)

```
$backlog->space->activities();
```

### スペースのお知らせの更新

[](#スペースのお知らせの更新)

```
$backlog->space->putNotification(string $content_body);
```

### スペースの容量使用状況の取得

[](#スペースの容量使用状況の取得)

```
$backlog->space->diskUsage();
```

### 添付ファイルの送信

[](#添付ファイルの送信)

```
$multipart = [
    [
        'name' => 'file',
        'contents' => fopen('test.txt', 'r'),
        'filename' => 'file name',
        'headers' => [
            'Content-Type' => 'application/octet-stream'
        ]
    ]
];
$backlog->space->postAttachment(array $multipart);
```

### 以下未実装

[](#以下未実装)

- GET /api/v2/space/image
- GET /api/v2/space/attachment

Users
-----

[](#users)

### ユーザー一覧の取得

[](#ユーザー一覧の取得)

```
$backlog->users->load();
```

### ユーザー情報の取得

[](#ユーザー情報の取得)

```
$backlog->users->find(int $user_id);
```

### ユーザーの追加

[](#ユーザーの追加)

```
$backlog->users->create(int $user_id, string $password, string $name, string $mail_address, int $role_type);
```

クエリパラメータは以下参照

### 認証ユーザー情報の取得

[](#認証ユーザー情報の取得)

```
$backlog->users->myself();
```

### ユーザーの最近の活動の取得

[](#ユーザーの最近の活動の取得)

```
$backlog->users->activities(int $user_id[, array $query_params = []]);
```

クエリパラメータは以下参照

### ユーザーの受け取ったスター一覧の取得

[](#ユーザーの受け取ったスター一覧の取得)

```
$backlog->users->stars(int $user_id[, array $query_params = []]);
```

クエリパラメータは以下参照

### ユーザーの受け取ったスターの数の取得

[](#ユーザーの受け取ったスターの数の取得)

```
$backlog->users->numberOfStars(int $user_id[, array $query_params = []]);
```

クエリパラメータは以下参照

### 自分が最近見た課題一覧の取得

[](#自分が最近見た課題一覧の取得)

```
$backlog->users->recentlyViewedIssues([array $query_params = []]);
```

クエリパラメータは以下参照

### 自分が最近見たプロジェクト一覧の取得

[](#自分が最近見たプロジェクト一覧の取得)

```
$backlog->users->recentlyViewedProjects([array $query_params = []]);
```

クエリパラメータは以下参照

### 自分が最近見たWiki一覧の取得

[](#自分が最近見たwiki一覧の取得)

```
$backlog->users->recentlyViewedWikis([array $query_params = []]);
```

クエリパラメータは以下参照

### 以下未実装

[](#以下未実装-1)

- PATCH /api/v2/users/:userId
- DELETE /api/v2/users/:userId
- GET /api/v2/users/:userId/icon

Groups
------

[](#groups)

### グループ一覧の取得

[](#グループ一覧の取得)

```
$backlog->groups->load([array $query_params = []]);
```

クエリパラメータは以下参照

### グループ情報の取得

[](#グループ情報の取得)

```
$backlog->groups->find(int $group_id);
```

### 以下未実装

[](#以下未実装-2)

- POST /api/v2/groups
- PATCH /api/v2/groups/:groupId
- DELETE /api/v2/groups/:groupId

Projects
--------

[](#projects)

### プロジェクト一覧の取得

[](#プロジェクト一覧の取得)

```
$backlog->projects->load([array $query_params = []]);
```

クエリパラメータは以下参照

### プロジェクトの状態一覧の取得

[](#プロジェクトの状態一覧の取得)

```
$backlog->projects->statuses(string $project_id_or_key);
```

### プロジェクト情報の取得

[](#プロジェクト情報の取得)

```
$backlog->projects->find(string $project_id_or_key);
```

### プロジェクトの最近の活動の取得

[](#プロジェクトの最近の活動の取得)

```
$backlog->projects->activities(string $project_id_or_key[, array $query_params = []]);
```

クエリパラメータは以下参照

### プロジェクトユーザー一覧の取得

[](#プロジェクトユーザー一覧の取得)

```
$backlog->projects->users(string $project_id_or_key);
```

### プロジェクト管理者一覧の取得

[](#プロジェクト管理者一覧の取得)

```
$backlog->projects->administrators(string $project_id_or_key);
```

### 種別一覧の取得

[](#種別一覧の取得)

```
$backlog->projects->issueTypes(string $project_id_or_key);
```

### 種別の追加

[](#種別の追加)

```
$backlog->projects->createIssueType(string $project_id_or_key, string $name, string $color);
```

### 種別情報の更新

[](#種別情報の更新)

```
$backlog->projects->updateIssueType(string $project_id_or_key, int $issue_type_id[, array $form_options = []]);
```

リクエストパラメータは以下参照

### 種別の削除

[](#種別の削除)

```
$backlog->projects->deleteIssueType(string $project_id_or_key, int $issue_type_id, int $substitute_issue_type_id);
```

### カテゴリー一覧の取得

[](#カテゴリー一覧の取得)

```
$backlog->projects->categories(string $project_id_or_key);
```

### カテゴリーの追加

[](#カテゴリーの追加)

```
$backlog->projects->createCategory(string $project_id_or_key, string $name);
```

### カテゴリー情報の更新

[](#カテゴリー情報の更新)

```
$backlog->projects->updateCategory(string $project_id_or_key, int $category_id[, array $form_options = []]);
```

リクエストパラメータは以下参照

### カテゴリーの削除

[](#カテゴリーの削除)

```
$backlog->projects->deleteCategory(string $project_id_or_key, int $category_id);
```

### バージョン(マイルストーン)一覧の取得

[](#バージョンマイルストーン一覧の取得)

```
$backlog->projects->versions(string $project_id_or_key);
```

### バージョン(マイルストーン)の追加

[](#バージョンマイルストーンの追加)

```
$backlog->projects->createVersion(string $project_id_or_key, string $name[, array $form_options = []]);
```

リクエストメータは以下参照

### バージョン(マイルストーン)情報の更新

[](#バージョンマイルストーン情報の更新)

```
$backlog->projects->updateVersion(string $project_id_or_key, int $version_id, string $name[, array $form_options = []]);
```

リクエストパラメータは以下参照

### バージョン(マイルストーン)の削除

[](#バージョンマイルストーンの削除)

```
$backlog->projects->deleteVersion(string $project_id_or_key, int $version_id);
```

### プロジェクトの容量使用状況の取得

[](#プロジェクトの容量使用状況の取得)

```
$backlog->projects->diskUsage(string $project_id_or_key);
```

### 以下未実装

[](#以下未実装-3)

- POST /api/v2/projects
- POST /api/v2/projects/:projectIdOrKey
- DELETE /api/v2/projects/:projectIdOrKey
- GET /api/v2/projects/:projectIdOrKey/image
- POST /api/v2/projects/:projectIdOrKey/users
- DELETE /api/v2/projects/:projectIdOrKey/users
- POST /api/v2/projects/:projectIdOrKey/administrators
- DELETE /api/v2/projects/:projectIdOrKey/administrators
- GET /api/v2/projects/:projectIdOrKey/customFields
- POST /api/v2/projects/:projectIdOrKey/customFields
- PATCH /api/v2/projects/:projectIdOrKey/customFields/:id
- DELETE /api/v2/projects/:projectIdOrKey/customFields/:id
- POST /api/v2/projects/:projectIdOrKey/customFields/:id/items
- PATCH /api/v2/projects/:projectIdOrKey/customFields/:id/items/:itemId
- DELETE /api/v2/projects/:projectIdOrKey/customFields/:id/items/:itemId
- GET /api/v2/projects/:projectIdOrKey/files/metadata/:path
- GET /api/v2/projects/:projectIdOrKey/files/:sharedFileId
- GET /api/v2/projects/:projectIdOrKey/webhooks
- POST /api/v2/projects/:projectIdOrKey/webhooks
- GET /api/v2/projects/:projectIdOrKey/webhooks/:webhookId
- PATCH /api/v2/projects/:projectIdOrKey/webhooks/:webhookId
- DELETE /api/v2/projects/:projectIdOrKey/webhooks/:webhookId

Issues
------

[](#issues)

### 課題一覧の取得

[](#課題一覧の取得)

```
$backlog->issues->load([array $query_options = []]);
```

クエリパラメータは以下参照

### 課題数の取得

[](#課題数の取得)

```
$backlog->issues->count([array $query_options = []]);
```

クエリパラメータは以下参照

### 課題の追加

[](#課題の追加)

```
$backlog->issues->create(int $project_id, string $summary, int $issue_type_id, int $priority_id[, array $form_options = []]);

```

リクエストパラメータは以下参照

### 課題情報の取得

[](#課題情報の取得)

```
$backlog->issues->find(string $issues_id_or_key);
```

### 課題情報の更新

[](#課題情報の更新)

```
$backlog->issues->update(string $issues_id_or_key[, array $form_options = []]);
```

リクエストパラメータは以下参照

### 課題の削除

[](#課題の削除)

```
$backlog->issues->delete(string $issues_id_or_key);
```

### 課題コメントの取得

[](#課題コメントの取得)

```
$backlog->issues->comments(string $issues_id_or_key[, array $query_options = []]);
```

クエリパラメータは以下参照

### 課題コメントの追加

[](#課題コメントの追加)

```
$backlog->issues->createComment(string $issues_id_or_key, string $content[, array $form_options = []]);
```

リクエストパラメータは以下参照

### 課題コメント数の取得

[](#課題コメント数の取得)

```
$backlog->issues->numberOfComments(string $issues_id_or_key);
```

### 課題コメント情報の取得

[](#課題コメント情報の取得)

```
$backlog->issues->findComment(string $issues_id_or_key, int $comment_id);
```

### 課題コメント情報の更新

[](#課題コメント情報の更新)

```
$backlog->issues->updateComment(string $issues_id_or_key, int $comment_id[, array $form_options = []]);
```

リクエストパラメータは以下参照

### 課題コメントのお知らせ一覧の取得

[](#課題コメントのお知らせ一覧の取得)

```
$backlog->issues->commentNotifications(string $issues_id_or_key, int $comment_id);
```

### 課題コメントにお知らせを追加

[](#課題コメントにお知らせを追加)

```
$backlog->issues->createCommentNotification(string $issues_id_or_key, int $comment_id[, array $form_options = []]);
```

リクエストパラメータは以下参照

### 課題添付ファイル一覧の取得

[](#課題添付ファイル一覧の取得)

```
$backlog->issues->attachments(string $issues_id_or_key);
```

### 課題添付ファイルのダウンロード

[](#課題添付ファイルのダウンロード)

```
$backlog->issues->attachment(string $issues_id_or_key, string $attachment_id);
```

### 課題共有ファイル一覧の取得

[](#課題共有ファイル一覧の取得)

```
$backlog->issues->sharedFiles(string $issues_id_or_key);
```

### 以下未実装

[](#以下未実装-4)

- DELETE /api/v2/issues/:issueIdOrKey/attachments/:attachmentId
- POST /api/v2/issues/:issueIdOrKey/sharedFiles
- DELETE /api/v2/issues/:issueIdOrKey/sharedFiles/:id

Wikis
-----

[](#wikis)

### Wikiページ一覧の取得

[](#wikiページ一覧の取得)

```
$backlog->wikis->load(string $project_id_or_key);
```

### Wikiページ数の取得

[](#wikiページ数の取得)

```
$backlog->wikis->count($project_id_or_key);
```

### Wikiページタグ一覧の取得

[](#wikiページタグ一覧の取得)

```
$backlog->wikis->tags($project_id_or_key);
```

### Wikiページの追加

[](#wikiページの追加)

```
$backlog->wikis->create(int $project_id, string $name, string $content[, array $form_options = []]);
```

リクエストパラメータは以下参照

### Wikiページ情報の取得

[](#wikiページ情報の取得)

```
$backlog->wikis->find(int $wiki_id);
```

### Wikiページ情報の更新

[](#wikiページ情報の更新)

```
$backlog->wikis->update(int wiki_id[, array $form_options = []);
```

リクエストパラメータは以下参照

### Wikiページの削除

[](#wikiページの削除)

```
$backlog->wikis->delete(int $wiki_id);
```

### Wiki添付ファイル一覧の取得

[](#wiki添付ファイル一覧の取得)

```
$backlog->wikis->attachments(int $wiki_id);
```

### Wikiページ更新履歴一覧の取得

[](#wikiページ更新履歴一覧の取得)

```
$backlog->wikis->history(int $wiki_id[, array $query_options = []]);
```

クエリパラメータは以下参照

### Wikiページのスター一覧の取得

[](#wikiページのスター一覧の取得)

```
$backlog->wikis->stars(int $wiki_id);
```

### 以下未実装

[](#以下未実装-5)

- POST /api/v2/wikis/:wikiId/attachments
- GET /api/v2/wikis/:wikiId/attachments/:attachmentId
- DELETE /api/v2/wikis/:wikiId/attachments/:attachmentId
- GET /api/v2/wikis/:wikiId/sharedFiles
- POST /api/v2/issues/:issueIdOrKey/sharedFiles
- DELETE /api/v2/wikis/:wikiId/sharedFiles/:id

Notifications
-------------

[](#notifications)

### お知らせ一覧の取得

[](#お知らせ一覧の取得)

```
$backlog->notifications->load([array $query_options = []]);
```

クエリパラメータは以下参照

### お知らせ数の取得

[](#お知らせ数の取得)

```
$backlog->notifications->count([array $query_options = []]);
```

クエリパラメータは以下参照

### お知らせ数のリセット

[](#お知らせ数のリセット)

```
$backlog->notifications->markAllAsRead();
```

### お知らせの既読化

[](#お知らせの既読化)

```
$backlog->notifications->markAsRead(int $notification_id);
```

Git
---

[](#git)

### Gitリポジトリ一覧の取得

[](#gitリポジトリ一覧の取得)

```
$backlog->git->repositories(string $project_id_or_key);
```

### Gitリポジトリの取得

[](#gitリポジトリの取得)

```
$backlog->git->findRepositories(string $project_id_or_key, string $repository_id_or_name);
```

### プルリクエスト一覧の取得

[](#プルリクエスト一覧の取得)

```
$backlog->git->pullRequests(string $project_id_or_key, string $repository_id_or_name[, array $query_options = []]);
```

クエリパラメータは以下参照

### プルリクエスト数の取得

[](#プルリクエスト数の取得)

```
$backlog->git->numberOfPullRequests(string $project_id_or_key, string $repository_id_or_name[, array $query_options = []]);
```

クエリパラメータは以下参照

### プルリクエストの追加

[](#プルリクエストの追加)

```
$backlog->git->createPullRequests(string $project_id_or_key, string $repository_id_or_name, string $summary, string $description, string $base_branch, string $merge_branch[, array $form_options = []]);
```

リクエストパラメータは以下参照

### プルリクエストの取得

[](#プルリクエストの取得)

```
$backlog->git->findPullRequest(string $project_id_or_key, string $repository_id_or_name, int $pull_request_number);
```

### プルリクエストの更新

[](#プルリクエストの更新)

```
$backlog->git->updatePullRequest(string $project_id_or_key, string $repository_id_or_name, int $pull_request_number[, array $form_options = []]);
```

リクエストパラメータは以下参照

### プルリクエストコメントの取得

[](#プルリクエストコメントの取得)

```
$backlog->git->pullRequestComments(string $project_id_or_key, string $repository_id_or_name, int $pull_request_number[, array $query_options = []]);
```

クエリパラメータは以下参照

### プルリクエストコメントの追加

[](#プルリクエストコメントの追加)

```
$backlog->git->createPullRequestComment(string $project_id_or_key, string $repository_id_or_name,  int $pull_request_number, string $content[, array $form_options = []]);
```

リクエストパラメータは以下参照

### プルリクエストコメント数の取得

[](#プルリクエストコメント数の取得)

```
$backlog->git->numberOfPullRequestComments(string $project_id_or_key, string $repository_id_or_name, int $pull_request_number);
```

### プルリクエストコメント情報の更新

[](#プルリクエストコメント情報の更新)

```
$backlog->git->updatePullRequestComment(string $project_id_or_key, string $repository_id_or_name, int $pull_request_number, int $comment_id[, array $form_options = []]);
```

リクエストパラメータは以下参照

### プルリクエスト添付ファイル一覧の取得

[](#プルリクエスト添付ファイル一覧の取得)

```
$backlog->git->pullRequestAttachments(string $project_id_or_key, string $repository_id_or_name, int $pull_request_number);
```

### 以下未実装

[](#以下未実装-6)

- GET /api/v2/projects/:projectIdOrKey/git/repositories/:repoIdOrName/pullRequests/:number/attachments/:attachmentId
- DELETE /api/v2/projects/:projectIdOrKey/git/repositories/:repoIdOrName/pullRequests/:number/attachments/:attachmentId

Watchings
---------

[](#watchings)

### ウォッチ一覧の取得

[](#ウォッチ一覧の取得)

```
$backlog->watchings->load(int $user_id[, array $query_options = []]);
```

クエリパラメータは以下参照

### ウォッチ数の取得

[](#ウォッチ数の取得)

```
$backlog->watchings->count(int $user_id[, array $query_options = []]);
```

クエリパラメータは以下参照

### ウォッチ情報の取得

[](#ウォッチ情報の取得)

```
$backlog->watchings->find(int $watching_id);
```

### ウォッチの追加

[](#ウォッチの追加)

```
$backlog->watchings->create(string $issues_id_or_key[, array $form_options = []]);
```

リクエストパラメータは以下参照

### ウォッチの更新

[](#ウォッチの更新)

```
$backlog->watchings->update(int $watching_id[, array $form_options = []]);
```

リクエストパラメータは以下参照

### ウォッチの削除

[](#ウォッチの削除)

```
$backlog->watchings->delete(int $watching_id);
```

### ウォッチの既読化

[](#ウォッチの既読化)

```
$backlog->watchings->markAsRead(int $watching_id);
```

License
=======

[](#license)

The MIT License (MIT).

###  Health Score

26

—

LowBetter than 43% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity23

Limited adoption so far

Community11

Small or concentrated contributor base

Maturity42

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 78.4% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Unknown

Total

1

Last Release

1884d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/5c09e9a745bb0d639d1fc510a567bc4969a1b3fcd7863b7e71c6cbdebdb8fe03?d=identicon)[namdp06](/maintainers/namdp06)

---

Top Contributors

[![itigoppo](https://avatars.githubusercontent.com/u/1428989?v=4)](https://github.com/itigoppo "itigoppo (40 commits)")[![biplobice](https://avatars.githubusercontent.com/u/2462951?v=4)](https://github.com/biplobice "biplobice (7 commits)")[![cbanick](https://avatars.githubusercontent.com/u/85145632?v=4)](https://github.com/cbanick "cbanick (3 commits)")[![soudai](https://avatars.githubusercontent.com/u/1297128?v=4)](https://github.com/soudai "soudai (1 commits)")

###  Code Quality

TestsPHPUnit

Code StylePHP\_CodeSniffer

### Embed Badge

![Health badge](/badges/phuongnamdang-laravel-backlog-api/health.svg)

```
[![Health](https://phpackages.com/badges/phuongnamdang-laravel-backlog-api/health.svg)](https://phpackages.com/packages/phuongnamdang-laravel-backlog-api)
```

###  Alternatives

[tencentcloud/tencentcloud-sdk-php

TencentCloudApi php sdk

3731.2M42](/packages/tencentcloud-tencentcloud-sdk-php)[convertkit/convertkitapi

Kit PHP SDK for the Kit API

2167.1k1](/packages/convertkit-convertkitapi)[mapado/rest-client-sdk

Rest Client SDK for hydra API

1125.9k2](/packages/mapado-rest-client-sdk)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)