kintone APIドキュメント

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.api()を使ったリクエスト

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

1

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