kintone全体を検索する

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

警告

このページで説明しているAPIは、開発を検討中のAPIです。

アップデートオプション内の「検討中の新機能」から動作をお試しいただけます。設定方法は、新機能の有効／無効の切り替え手順を参照してください。

APIに関するフィードバックを、ユースケースとともに、 kintoneの改善に協力するフォームへぜひご登録ください。

フィードバックの例

APIラボで提供されているAPIを早く本番環境で利用したい
こういう用途で使うために、このようなAPIを提供してほしい

kintone全体を検索します。

利用するには検討中の新機能の「kintone全体を検索するREST API」を有効にしてください。

HTTPメソッド	POST
URL	https://sample.cybozu.com/k/v1/search.json
URL（ゲストスペース）	（参加しているすべてのゲストスペースから検索する場合） https://sample.cybozu.com/k/guest/v1/search.json （特定のゲストスペースから検索する場合） https://sample.cybozu.com/k/guest/`GUEST_SPACE_ID`/v1/search.json
認証	パスワード認証 , セッション認証
Content-Type	application/json

リクエストパラメーター

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

パラメーター名	型	必須	説明
query	配列	必須	検索条件 1個以上20個以下を指定します。複数指定した場合、すべての条件を満たすデータが返ります。
query[].operator	文字列	必須	検索条件の評価方法次のいずれかの値を指定します。 `AND`：すべての検索語を含むデータが返ります `OR`：いずれかの検索語を含むデータが返ります `NOT`：検索語を含まないデータが返ります `query`が`AND`または`OR`を使用した検索条件を1つも含まない場合、検索結果は空になります。
query[].keywords	配列	必須	検索語の配列 1個以上20個以下を指定します。 1つの検索語は1文字以上50文字以下で指定します。 `query`全体で検索語は20個まで指定できます。超過するとエラーが返ります。
types	配列	省略可	検索対象とするデータの種類次のいずれかの値を指定します。 `RECORD`：レコード `RECORD_COMMENT`：レコードコメント `SPACE`：スペース `THREAD`：スレッド `THREAD_COMMENT`：スレッドのコメント `PEOPLE_COMMENT`：ピープルのコメント `MESSAGE_COMMENT`：メッセージのコメント `ATTACHMENT`：添付ファイル省略した場合はすべての種類を検索対象にします。
scopes	配列	省略可	検索範囲 20個以下を指定します。複数指定した場合、いずれかの条件を満たすデータが返ります。
scopes[].scope	文字列	必須	検索範囲の種類次のいずれかの値を指定します。 `APP`：アプリ `SPACE`：スペース `PEOPLE`：ピープル `MESSAGE`：メッセージ `scopes`を指定する場合は必須です。
scopes[].ids	配列	省略可	アプリIDまたはスペースID 20個以下を指定します。 `scopes[].scope`が`APP`または`SPACE`の場合、アプリIDやスペースIDを指定することにより、検索範囲とするアプリやスペースを限定できます。省略した場合はすべてのアプリまたはすべてのスペースを検索範囲にします。`scopes[].scope`が`PEOPLE`または`MESSAGE`の場合、指定することはできません。
scopes[].codes	配列	省略可	ユーザーのログイン名 20個以下を指定します。 `scopes[].scope`が`PEOPLE`または`MESSAGE`の場合、ピープルの所有者やメッセージの相手ユーザーのログイン名を指定することにより、検索範囲とするピープルやメッセージを限定できます。省略した場合はすべてのピープルまたはすべてのメッセージを検索範囲にします。`scopes[].scope`が`APP`または`SPACE`の場合、指定することはできません。
excludeScopes	配列	省略可	除外する検索範囲 20個以下を指定します。複数指定した場合、すべての条件を満たすデータが返ります。 `scopes`と`excludeScopes`を同時に指定した場合、両方の条件を満たすデータが返ります。したがって、両者の範囲に重なりがあった場合は`excludeScopes`が優先されます。
excludeScopes[].scope	文字列	必須	除外する検索範囲の種類次のいずれかの値を指定します。 `APP`：アプリ `SPACE`：スペース `PEOPLE`：ピープル `MESSAGE`：メッセージ `excludeScopes`を指定する場合は必須です。
excludeScopes[].ids	配列	省略可	アプリIDまたはスペースID 20個以下を指定します。 `excludeScopes[].scope`が`APP`または`SPACE`の場合、アプリIDやスペースIDを指定することにより、検索範囲から除外するアプリやスペースを限定できます。省略した場合はすべてのアプリまたはすべてのスペースを検索範囲から除外します。`excludeScopes[].scope`が`PEOPLE`または`MESSAGE`の場合、指定することはできません。
excludeScopes[].codes	配列	省略可	ユーザーのログイン名 20個以下を指定します。 `excludeScopes[].scope`が`PEOPLE`または`MESSAGE`の場合、ピープルの所有者やメッセージの相手ユーザーのログイン名を指定することにより、検索範囲から除外するピープルやメッセージを限定できます。省略した場合はすべてのピープルまたはすべてのメッセージを検索範囲から除外します。`excludeScopes[].scope`が`APP`または`SPACE`の場合、指定することはできません。
createdAfter	文字列	省略可	作成日時の下限指定した日時と作成日時が等しいか、新しいデータが返ります。`createdBefore`よりも新しい日時は指定できません。日時のフォーマットは次のページを参照してください。日時のフォーマット
createdBefore	文字列	省略可	作成日時の上限指定した日時と作成日時が等しいか、古いデータが返ります。`createdAfter`よりも古い日時は指定できません。日時のフォーマットは次のページを参照してください。日時のフォーマット
creators	配列	省略可	作成者のログイン名 20個以下を指定します。
sort	オブジェクト	省略可	ソート条件
sort.by	文字列	省略可	ソートの基準次のいずれかの値を指定します。 `RELEVANCE`：検索語との関連度 `CREATED_AT`：作成日時省略した場合は`RELEVANCE`になります。
sort.order	文字列	省略可	ソートの方向次のいずれかの値を指定します。 `ASC`：昇順 `DESC`：降順省略した場合は`DESC`になります。 `sort.by`が`RELEVANCE`の場合、`ASC`は指定できません。
limit	数値または文字列	省略可	最大取得件数 1以上20以下を指定します。省略した場合は`20`になります。検索条件に合致するデータが残っていたとしても、最大取得件数に満たない状態でレスポンスが返る場合があります。検索条件に合致するデータが残っているかどうかは、レスポンスの`nextPageToken`プロパティの値の有無で判定してください。
pageToken	文字列	省略可	検索結果の続きを取得するためのトークン初回のリクエストでは省略します。前回の検索結果の続きを取得する場合、前回のレスポンスに含まれる`nextPageToken`の値を指定します。

レスポンスプロパティ

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

プロパティ名	型	説明
hits	配列	検索結果
hits[].type	文字列	検索結果の種類次のいずれかが返ります。 `RECORD` `RECORD_COMMENT` `SPACE` `THREAD` `THREAD_COMMENT` `PEOPLE_COMMENT` `MESSAGE_COMMENT` `ATTACHMENT`
hits[].url	文字列	URL この検索結果が添付ファイルの場合は添付先の URL になります。
hits[].snippets	配列	検索語の周辺テキスト最大3件が返ります。
hits[].record	オブジェクト	レコードの情報この検索結果がレコードであるか、レコードに添付されたファイルである場合にのみ存在します。
hits[].record.appId	文字列	アプリID
hits[].record.appName	文字列	アプリ名
hits[].record.recordId	文字列	レコードID
hits[].record.recordTitle	文字列	レコードタイトル
hits[].record.createdAt	文字列	作成日時
hits[].record.creator	オブジェクト	作成者
hits[].record.creator.code	文字列	作成者のログイン名
hits[].record.creator.name	文字列	作成者の表示名
hits[].record.matchedFields	配列	検索語にマッチしたフィールド
hits[].record.matchedFields[].code	文字列	フィールドコード
hits[].record.matchedFields[].label	文字列	フィールド名
hits[].record.spaceId	文字列	スペースID スペース内アプリのレコードの場合にのみ存在します。
hits[].record.spaceName	文字列	スペース名スペース内アプリのレコードの場合にのみ存在します。
hits[].recordComment	オブジェクト	レコードコメントの情報この検索結果がレコードコメントである場合にのみ存在します。
hits[].recordComment.appId	文字列	アプリID
hits[].recordComment.appName	文字列	アプリ名
hits[].recordComment.recordId	文字列	レコードID
hits[].recordComment.recordTitle	文字列	レコードタイトル
hits[].recordComment.commentId	文字列	コメントID
hits[].recordComment.createdAt	文字列	作成日時
hits[].recordComment.creator	オブジェクト	作成者
hits[].recordComment.creator.code	文字列	作成者のログイン名
hits[].recordComment.creator.name	文字列	作成者の表示名
hits[].recordComment.spaceId	文字列	スペースID スペース内アプリのレコードの場合にのみ存在します。
hits[].recordComment.spaceName	文字列	スペース名スペース内アプリのレコードの場合にのみ存在します。
hits[].space	オブジェクト	スペースの情報この検索結果がスペースであるか、スペースに添付されたファイルである場合にのみ存在します。
hits[].space.spaceId	文字列	スペースID
hits[].space.spaceName	文字列	スペース名
hits[].space.createdAt	文字列	作成日時
hits[].space.creator	オブジェクト	作成者
hits[].space.creator.code	文字列	作成者のログイン名
hits[].space.creator.name	文字列	作成者の表示名
hits[].thread	オブジェクト	スレッドの情報この検索結果がスレッドであるか、スレッドに添付されたファイルである場合にのみ存在します。
hits[].thread.threadId	文字列	スレッドID
hits[].thread.threadName	文字列	スレッド名
hits[].thread.spaceId	文字列	スペースID
hits[].thread.spaceName	文字列	スペース名
hits[].thread.createdAt	文字列	作成日時
hits[].thread.creator	オブジェクト	作成者
hits[].thread.creator.code	文字列	作成者のログイン名
hits[].thread.creator.name	文字列	作成者の表示名
hits[].threadComment	オブジェクト	スレッドのコメントの情報この検索結果がスレッドのコメントであるか、スレッドのコメントに添付されたファイルである場合にのみ存在します。
hits[].threadComment.commentId	文字列	コメントのID
hits[].threadComment.replyId	文字列	返信のID この検索結果が返信の場合にのみ存在します。
hits[].threadComment.spaceId	文字列	スペースID
hits[].threadComment.spaceName	文字列	スペース名
hits[].threadComment.threadId	文字列	スレッドID
hits[].threadComment.threadName	文字列	スレッド名
hits[].threadComment.createdAt	文字列	作成日時
hits[].threadComment.creator	オブジェクト	作成者
hits[].threadComment.creator.code	文字列	作成者のログイン名
hits[].threadComment.creator.name	文字列	作成者の表示名
hits[].peopleComment	オブジェクト	ピープルのコメントの情報この検索結果がピープルのコメントであるか、ピープルのコメントに添付されたファイルである場合にのみ存在します。
hits[].peopleComment.commentId	文字列	コメントのID
hits[].peopleComment.replyId	文字列	返信のID この検索結果が返信の場合にのみ存在します。
hits[].peopleComment.owner	オブジェクト	ピープルの所有者
hits[].peopleComment.owner.code	文字列	ピープルの所有者のログイン名
hits[].peopleComment.owner.name	文字列	ピープルの所有者の表示名
hits[].peopleComment.createdAt	文字列	作成日時
hits[].peopleComment.creator	オブジェクト	作成者
hits[].peopleComment.creator.code	文字列	作成者のログイン名
hits[].peopleComment.creator.name	文字列	作成者の表示名
hits[].messageComment	オブジェクト	メッセージのコメントの情報この検索結果がメッセージのコメントであるか、メッセージのコメントに添付されたファイルである場合にのみ存在します。
hits[].messageComment.commentId	文字列	コメントのID
hits[].messageComment.createdAt	文字列	作成日時
hits[].messageComment.creator	オブジェクト	作成者このコメントを書き込んだユーザーになります。
hits[].messageComment.creator.code	文字列	作成者のログイン名
hits[].messageComment.creator.name	文字列	作成者の表示名
hits[].messageComment.recipient	オブジェクト	コメントの受信者メッセージの参加者のうち、作成者ではないほうのユーザーになります。
hits[].messageComment.recipient.code	文字列	受信者のログイン名
hits[].messageComment.recipient.name	文字列	受信者の表示名
hits[].attachment	オブジェクト	添付ファイルの情報この検索結果が添付ファイルである場合にのみ存在します。
hits[].attachment.attachedTo	文字列	添付先の種類次のいずれかが返ります。 `RECORD` `SPACE` `THREAD` `THREAD_COMMENT` `PEOPLE_COMMENT` `MESSAGE_COMMENT`
hits[].attachment.fileKey	文字列	ファイルキー
hits[].attachment.name	文字列	ファイル名
hits[].attachment.createdAt	文字列	作成日時
hits[].attachment.creator	オブジェクト	作成者
hits[].attachment.creator.code	文字列	作成者のログイン名
hits[].attachment.creator.name	文字列	作成者の表示名
nextPageToken	文字列	検索結果の続きを取得するためのトークン次のページをリクエストする際、リクエストパラメーターの`pageToken`に指定します。次のページが存在しない場合は`null`になります。

必要なアクセス権

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

なし

認証に使用したユーザーが閲覧権限をもつデータを対象に検索します。

サンプル

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

サンプルリクエスト

リクエストヘッダー

1
2
3
4


{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU=",
  "Content-Type": "application/json"
}

リクエストヘッダーの詳細は共通仕様を参照してください。 kintone REST APIの共通仕様

リクエストボディ（複数キーワード検索）

abcとdefの両方を含むデータを検索するリクエストボディの例です。

1
2
3
4
5
6
7
8


{
  "query": [
    {
      "operator": "AND",
      "keywords": ["abc", "def"]
    }
  ]
}

リクエストボディ（除外するキーワードの指定）

abcを含みdefを含まないデータを検索するリクエストボディの例です。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12


{
  "query": [
    {
      "operator": "AND",
      "keywords": ["abc"]
    },
    {
      "operator": "NOT",
      "keywords": ["def"]
    }
  ]
}

リクエストボディ（アプリを指定して検索）

アプリ1とアプリ2の中からabcを含む添付ファイルを検索するリクエストボディの例です。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15


{
  "query": [
    {
      "operator": "AND",
      "keywords": ["abc"]
    }
  ],
  "types": ["ATTACHMENT"],
  "scopes": [
    {
      "scope": "APP",
      "ids": [1, 2]
    }
  ]
}

リクエストボディ（スペースを指定して検索）

スペース1の中からabcを含むデータを検索するが、スペース1の中にあるアプリ2のデータは除外するリクエストボディの例です。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20


{
  "query": [
    {
      "operator": "AND",
      "keywords": ["abc"]
    }
  ],
  "scopes": [
    {
      "scope": "SPACE",
      "ids": [1]
    }
  ],
  "excludeScopes": [
    {
      "scope": "APP",
      "ids": [2]
    }
  ]
}

リクエストボディ（期間を指定して検索）

特定の期間内にユーザーuser1が作成したデータを作成日時の昇順で検索するリクエストボディの例です。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15


{
  "query": [
    {
      "operator": "AND",
      "keywords": ["abc"]
    }
  ],
  "creators": ["user1"],
  "createdAfter": "2026-05-01T00:00:00+09:00",
  "createdBefore": "2026-05-31T23:59:59+09:00",
  "sort": {
    "by": "CREATED_AT",
    "order": "ASC"
  }
}

サンプルレスポンス

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80


{
  "hits": [
    {
      "type": "RECORD",
      "url": "https://sample.cybozu.com/k/760/show#record=12787",
      "snippets": [
        "営業支援を目的として、提案資料のテンプレートを新しく整備しました。"
      ],
      "record": {
        "appId": "760",
        "appName": "活動報告",
        "recordId": "12787",
        "recordTitle": "顧客対応の効率化に向けて",
        "createdAt": "2024-03-28T09:13:00.000Z",
        "creator": {
          "code": "user1",
          "name": "ユーザー1"
        },
        "matchedFields": [
          {
            "code": "summary",
            "label": "概要"
          }
        ],
        "spaceId": "18",
        "spaceName": "営業本部"
      }
    },
    {
      "type": "ATTACHMENT",
      "url": "https://sample.cybozu.com/k/25929/show#record=329",
      "snippets": [
        "商談管理を効率化する目的で、営業支援システムを更新しました。"
      ],
      "record": {
        "appId": "25929",
        "appName": "ファイル管理",
        "recordId": "329",
        "recordTitle": "329",
        "createdAt": "2025-08-04T06:53:00.000Z",
        "creator": {
          "code": "user2",
          "name": "ユーザー2"
        },
        "matchedFields": []
      },
      "attachment": {
        "attachedTo": "RECORD",
        "fileKey": "20250804065242B76047BB21494FE5BD4FA54590A50984300",
        "name": "予算管理表_2025年度.xlsx",
        "createdAt": "2025-08-04T06:53:00.000Z",
        "creator": {
          "code": "user2",
          "name": "ユーザー2"
        }
      }
    },
    {
      "type": "PEOPLE_COMMENT",
      "url": "https://sample.cybozu.com/k/#/people/user/user3/347030/182425",
      "snippets": [
        "顧客対応の品質向上に向けて、営業支援体制を見直しています。"
      ],
      "peopleComment": {
        "commentId": "347030",
        "owner": {
          "code": "user3",
          "name": "ユーザー3"
        },
        "createdAt": "2015-12-04T06:31:28.000Z",
        "creator": {
          "code": "user4",
          "name": "ユーザー4"
        },
        "replyId": "182425"
      }
    }
  ],
  "nextPageToken": "W1syLDE3Nzg2Mjg1NDAwMDBdLFsyLDIxNTc4XSxbMiw0NjAxOTg3XSxbMywicmVjb3JkIl0sWzMsIksuQTIxNTc4LlI0NjAxOTg3LlJPVzU1MTU2Njg2Il1d"
}

サンプルコード

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

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10


const body = {
  query: [
    {
      operator: "AND",
      keywords: ["abc", "def"]
    }
  ]
};

await kintone.api(kintone.api.url('/k/v1/search.json', true), 'POST', body);

curlを使ったリクエスト

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11


curl -X POST 'https://sample.cybozu.com/k/v1/search.json' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=' \
  -H 'Content-Type: application/json' \
  -d '{
    "query": [
      {
        "operator": "AND",
        "keywords": ["abc", "def"]
      }
    ]
  }'

注意事項

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

URL/k/v1/search.jsonにリクエストした場合、そのユーザーが参加しているゲストスペース内の情報も含め検索します。ただし、ゲストユーザーはこのURLにリクエストできません。
URL/k/guest/v1/search.jsonにリクエストした場合、そのユーザーが参加しているゲストスペース内の情報のみを検索します。
URL/k/guest/GUEST_SPACE_ID/v1/search.jsonにリクエストした場合、指定したゲストスペース内の情報のみを検索します。参加していないゲストスペースや存在しないゲストスペースを指定した場合、検索結果は空になります。
検索処理の改善に伴い、検索結果に含まれるデータやその並び順、hits[].snippetsの内容が変更される場合があります。

kintone API

kintone APIドキュメント