Get User Services

Gets the services that users use in the Kintone environment.

MethodGET
URLhttps://{subdomain}.kintone.com/v1/users/services.json
AuthenticationPassword Authentication
Content-Typeapplication/json (not needed if specifying the query with a query string)

Contents

Permissions

All users other than Guest Users can use this API.

Request Parameters

Parameter Value Required Description
codes Array of Strings Optional The list of the target user codes.
The maximum length of the array is 100.
If this parameter is ignored, all users will be targeted.
offset Integer Optional The offset.
If this parameter is ignored, 0 will be set.
size Integer Optional The maximum size of the array in the response.
1 to 100 can be specified.
If this parameter is ignored, 100 will be set.

Sample Request

JavaScript (using Kintone REST API Request )

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
var body = {
  'codes': ['user1', 'user2', 'user3'],
  'offset': 0,
  'size': 2
};
kintone.api(kintone.api.url('/v1/users/services', true), 'GET', body, function(resp) {
  // success
  console.log(resp);
}, function(error) {
  // error
  console.log(error);
});

Response Parameters

Parameter Type Description
users Array of Objects An array consisting of user codes and their related services.
The objects are listed in order of the user’s id.
users.code String The user’s code.
users.services Array of Strings The services being used by the user.
Users using Kintone will have the string "kintone" returned in the array.
If the user uses no services, an empty array will be returned.

Sample Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
{
  "users": [
    {
      "code": "user1",
      "services": ["kintone"]
    },
    {
      "code": "user2",
      "services": []
    },
    {
      "code": "user3",
      "services": ["kintone"]
    }
  ]
}

Limitations

  • The user “Administrator” will not be included in the response.