スペースのメンバーとスペース管理者の情報を取得する

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

スペースのメンバーとスペース管理者の情報を取得します。

HTTPメソッド	GET
URL	https://sample.cybozu.com/k/v1/space/members.json
URL（ゲストスペース）	https://sample.cybozu.com/k/guest/`GUEST_SPACE_ID`/v1/space/members.json
認証	パスワード認証 , セッション認証 , OAuth認証
Content-Type	application/json

リクエストパラメーター

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

パラメーター名	型	必須	説明
id	数値または文字列	必須	メンバー情報を取得するスペースのスペースID

レスポンスプロパティ

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

プロパティ名	型	説明
members	配列	スペースのメンバーの情報下記ユーザーはレスポンスに含まれません。ゲストユーザー kintoneを利用していないユーザー使用停止中のユーザー削除したユーザー
members[].entity	オブジェクト	スペースのメンバーの情報
members[].entity.type	文字列	スペースのメンバーの種類次のいずれかの値が返ります。 `USER`：ユーザー `GROUP`：グループ `ORGANIZATION`：組織
members[].entity.code	文字列	スペースのメンバーのコード
members[].isAdmin	真偽値	スペースのメンバーがスペース管理者かどうか `true`：スペース管理者 `false`：スペース管理者ではない
members[].isImplicit	真偽値	ユーザーとして追加されているかどうか `true`：ユーザーとして追加されていない（メンバーのグループ／組織に所属するユーザー） `false`：ユーザーとして追加されているメンバーの組織に所属しているユーザーでも、ユーザーとして登録されていれば「false」が返ります。 `entity.type`が「USER」以外の場合は、このプロパティが存在しません。
members[].includeSubs	真偽値	下位組織を含むかどうか `true`：下位組織を含む `false`：下位組織を含まない `entity.type`が「USER」以外の場合は、このプロパティが存在しません。

必要なアクセス権

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

スペースの閲覧権限
非公開スペースの場合、スペース参加者のみ実行可能です。

サンプル

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

サンプルリクエスト

リクエストURL（URLにパラメーターを含める場合）

1

https\://sample.cybozu.com/k/v1/space/members.json?id=1

リクエストヘッダー（URLにパラメーターを含める場合）

1
2
3


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

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

リクエストヘッダー（リクエストボディにパラメーターを含める場合）

1
2
3
4


{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU=",
  "Content-Type": "application/json"
}

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

リクエストボディ

1
2
3


{
  "id": "1"
}

サンプルレスポンス

 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


{
  "members": [
    {
      "entity": {
        "type": "USER",
        "code": "user1"
      },
      "isAdmin": false,
      "isImplicit": true
    },
    {
      "entity": {
        "type": "USER",
        "code": "user2"
      },
      "isAdmin": true,
      "isImplicit": false
    },
    {
      "entity": {
        "type": "GROUP",
        "code": "group1"
      },
      "isAdmin": false
    },
    {
      "entity": {
        "type": "ORGANIZATION",
        "code": "org1"
      },
      "isAdmin": false,
      "includeSubs": true
    }
  ]
}

サンプルコード

kintone.api()を使ったリクエスト

kintone.api()の詳細は、次のページを参照してください。
kintone REST APIリクエストを送信する

1
2
3
4
5


const body = {
  id: 1
};

await kintone.api(kintone.api.url('/k/v1/space/members.json', true), 'GET', body);

curlを使ったリクエスト

ご利用の環境によって、curlのフォーマットは異なる場合があります。
詳細は、次のページを参照してください。
curlコマンドでkintone REST APIを実行してみよう/3.API実行

1
2
3
4
5
6


curl -X GET 'https://sample.cybozu.com/k/v1/space/members.json' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": 1
  }'

補足

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

ゲストスペースでは、メンバーのみ取得できます。
スペース機能を利用していない場合には、エラーが発生します。
ゲストスペース機能が無効の場合に、ゲストスペースの情報を取得しようとするとエラーが発生します。

kintone API

kintone APIドキュメント

スペースのメンバーとスペース管理者の情報を取得する

目次

リクエストパラメーター

レスポンスプロパティ

必要なアクセス権

サンプル

補足