API Docs

Get Space Members

Gets the list of Space Members of a Space.

MethodGET
URLhttps://{subdomain}.kintone.com/k/v1/space/members.json
URL(guest space)https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/space/members.json
Authentication Password Authentication , Session Authentication
Content-Typeapplication/json (not needed if specifying the query with a query string)

Contents

Permissions

For Private Spaces, the user must be a member of the Space.

Request Parameters

Parameter Type Required Description
id Integer or String Yes The Space ID.

Sample Request

JavaScript using kintone.api() 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

var body = {
  'id': 1
};

kintone.api(kintone.api.url('/k/v1/space/members.json', true), 'GET', body, function(resp) {
  // success
  console.log(resp);
}, function(error) {
  // error
  console.log(error);
});

XMLHttpRequest

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15

var url = 'https://{subdomain}.kintone.com/k/v1/space/members.json?id=1';

var xhr = new XMLHttpRequest();
xhr.open('GET', url);
xhr.setRequestHeader('X-Requested-With', 'XMLHttpRequest');
xhr.onload = function() {
  if (xhr.status === 200) {
    // success
    console.log(JSON.parse(xhr.responseText));
  } else {
    // error
    console.log(JSON.parse(xhr.responseText));
  }
};
xhr.send();

Response Parameters

Parameter Type Description
members Array A list of Space members.
Guest users, inactive users and deleted users will not be included.
members[].entity Object The entity information of the Space member.
members[].entity.type String The entity type of the Space member.

USER: User
GROUP: Group
ORGANIZATION: Department
members[].entity.code String The code of the Space member.
members[].isAdmin Boolean The Space Admin settings of the Space member

true: The Space Member is the Space Administrator.
false: The Space Member is not the Space Administrator.
members[].isImplicit Boolean If the Space Member is added as a User or not.

true: The Space Member is not added as a user, and is added as part of a Group or Department.
false: The Space Member is added as a User.

This is not responded for GROUP and ORGANIZATION entities.
members[].includeSubs Boolean The "Include Affiliated Departments" setting of the Department Space Member.

true: Affiliated Departments are included.
false: Affiliated Departments are not included.

This is not responded for GROUP and ORGANIZATION entities.

Sample Response

 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
    }
  ]
}

Limitations

  • If the Space or Guest Space feature is turned off, an error will be returned.
  • Using this API on Guest Spaces will only return non-guest Space users.