Garoon APIドキュメント

スペースの一覧を取得する

目次

スペースの一覧を取得する

固定リンクがコピーされました

スペースの一覧を取得します。

URL

固定リンクがコピーされました

クラウド版

https://sample.cybozu.com/g/api/v1/space/spaces

HTTPメソッド

固定リンクがコピーされました

GET

利用できるバージョン

固定リンクがコピーされました

  • クラウド版Garoon

リクエスト

固定リンクがコピーされました

パラメーター

リクエストパラメーターは、URLクエリパラメーターとして送信してください。
ただし、 Garoon REST APIリクエストを送信するAPIを使って実行する場合は、リクエストボディとして指定できます。

パラメーター名 型 必須 説明
offset 数値 省略可 取得するスペースの先頭からスキップする数
省略すると、0が設定されます。
limit 数値 省略可 取得するスペース数の上限
最小値：0
最大値：1,000
省略すると、100が設定されます。
リクエストの例
ヘッダー
1
2
3

{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU="
}

リクエストヘッダーの詳細は Garoon REST APIの共通仕様を参照してください。

レスポンス

固定リンクがコピーされました

プロパティ
プロパティ名 型 説明
spaces 配列（オブジェクト） スペースの一覧
spaces[].id 文字列 スペースのID
spaces[].name 文字列 スペースの名前
spaces[].isPublic 真偽値 スペースの公開方法
  • true：公開
  • false：非公開
spaces[].category[].id 文字列 カテゴリのID
spaces[].category[].name 文字列 カテゴリの名前
spaces[].creator[].id 文字列 作成者のGaroonユーザーID
spaces[].creator[].name 文字列 作成者の表示名
spaces[].creator[].code 文字列 作成者のログイン名
spaces[].updater[].id 文字列 更新者のGaroonユーザーID
spaces[].updater[].name 文字列 更新者の表示名
spaces[].updater[].code 文字列 更新者のログイン名
spaces[].createdAt 文字列 作成日時
spaces[].updatedAt 文字列 更新日時
hasNext 真偽値 次のスペースがあるかどうか
  • true：次のスペースがある
  • false：次のスペースがない
レスポンスの例
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47

{
    "spaces": [
        {
            "id": "4",
            "name": "Space 1",
            "isPublic": false,
            "category": {
                "id": "2",
                "name": "General"
            },
            "creator": {
                "id": "2",
                "name": "user1",
                "code": "user1"
            },
            "updater": {
                "id": "16",
                "name": "user15",
                "code": "user15"
            },
            "createdAt": "2024-05-16T07:12:07Z",
            "updatedAt": "2024-05-16T07:27:31Z"
        },
        {
            "id": "3",
            "name": "Space 2",
            "isPublic": true,
            "category": {
                "id": "2",
                "name": "General"
            },
            "creator": {
                "id": "1",
                "name": "Administrator",
                "code": "Administrator"
            },
            "updater": {
                "id": "1",
                "name": "Administrator",
                "code": "Administrator"
            },
            "createdAt": "2024-05-16T07:04:54Z",
            "updatedAt": "2024-05-16T07:04:54Z"
        },
    ],
    "hasNext": false
}

サンプルコード

固定リンクがコピーされました

curlを使ったリクエスト
1
2

curl -X GET 'https://sample.cybozu.com/g/api/v1/space/spaces' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU='
Garoon REST APIリクエストを送信するAPIを使ったリクエスト
1

await garoon.api('/api/v1/space/spaces', 'GET', {});