Get API List

Gets the list of App/Record/Space APIs available to use on Kintone.

MethodGET
URLhttps://{subdomain}.kintone.com/k/v1/apis.json
AuthenticationNone
Content-Type

Contents

Permissions

This API requires no authentication.

Request Parameters

None

Sample Request

JavaScript (using Kintone REST API Request )

1
2
3
4
5
6
7
kintone.api(kintone.api.url('/k/v1/apis', true), 'GET', {}, 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/apis.json';

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
apis Object An object containing information of each API.
The {key} represents the ID string of each API
apis.{key} Object An object containing details of the API.
apis.{key}.link String The URL of the API, that can be used with the Get Schema API .

Sample Response

1
2
3
4
5
6
7
8
9
{
  "baseUrl": "https://{subdomain}.kintone.com/k/v1/",
  "apis": {
    "records/get": {
      "link": "apis/records/get.json"
    }
    // ...
  }
}