kintone REST API の一覧を取得する

目次

kintone REST API の一覧を取得する

kintone で利用可能な REST API の一覧を取得します。
次の API は取得できません。

URL

https://sample.cybozu.com/k/v1/apis.json

HTTP メソッド

GET

必要なアクセス権

なし

認証情報は不要です。

リクエスト

パラメーター

なし

リクエストの例
URL

https://sample.cybozu.com/k/v1/apis.json

ヘッダー

なし

レスポンス

プロパティ
プロパティ名 内容
apis オブジェクト 各 API の情報一覧
スペース・ピープル・ゲストスペース機能を無効にしている場合でも、すべての API 一覧を取得します。
apis.API の ID オブジェクト API の情報
API の ID は API を表す文字列です。
apis.API の ID.link 文字列 API のスキーマ情報を取得するための API の URL
レスポンスの例
1
2
3
4
5
6
7
8
9
{
  "baseUrl": "https://sample.cybozu.com/k/v1/",
  "apis": {
    "records/get": {
      "link": "apis/records/get.json"
    }
    // 省略
  }
}

サンプルコード

curl を使ったリクエスト
1
curl -X GET 'https://sample.cybozu.com/k/v1/apis.json'
kintone REST API リクエストを送信する API を使ったリクエスト
1
await kintone.api(kintone.api.url('/k/v1/apis.json', true), 'GET', {});