kintone REST APIの一覧を取得する

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

kintoneで利用可能なREST APIの一覧を取得します。

HTTPメソッド	GET
URL	https://sample.cybozu.com/k/v1/apis.json

リクエストパラメーター

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

なし

レスポンスプロパティ

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

プロパティ名	型	説明
baseUrl	文字列	APIを実行するときの基本となるURL
apis	オブジェクト	各APIの情報一覧スペース・ピープル・ゲストスペース機能を無効にしている場合でも、すべてのAPI一覧を取得します。
apis.`APIのID`	オブジェクト	APIの情報 `APIのID`はAPIを表す文字列です。
apis.`APIのID`.link	文字列	APIのスキーマ情報を取得するためのAPIのURL

必要なアクセス権

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

なし

認証情報は不要です。

サンプル

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

サンプルリクエスト

リクエストURL

1

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

リクエストヘッダー

なし

サンプルレスポンス

1
2
3
4
5
6
7
8
9


{
  "baseUrl": "https://sample.cybozu.com/k/v1/",
  "apis": {
    "records/get": {
      "link": "apis/records/get.json"
    }
    // 省略
  }
}

サンプルコード

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

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

1

await kintone.api(kintone.api.url('/k/v1/apis.json', true), 'GET', {});

curlを使ったリクエスト

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

1

curl -X GET 'https://sample.cybozu.com/k/v1/apis.json'

補足

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

次のAPIの情報は取得できません。

kintone REST APIの一覧を取得するAPI（このAPI）
kintone REST APIのスキーマ情報を取得するAPI

kintone API

kintone APIドキュメント

kintone REST APIの一覧を取得する

目次

リクエストパラメーター

レスポンスプロパティ

必要なアクセス権

サンプル

補足