メインコンテンツへスキップ
POST
検索

Supported products

承認

Authorization
string
header
必須

The access token received from the authorization server in the OAuth 2.0 flow.

Scopes

crm.objects.deals.read
crm.objects.subscriptions.read
crm.objects.services.read
crm.objects.tickets.sensitive.read
crm.objects.orders.read
crm.objects.listings.write
crm.objects.custom.read
crm.objects.companies.write
crm.objects.tasks.read
crm.objects.custom.sensitive.write.v2
crm.objects.custom.highly_sensitive.write.v2
crm.objects.companies.read
crm.objects.appointments.sensitive.read.v2
crm.objects.contacts.highly_sensitive.read.v2
crm.objects.tickets.highly_sensitive.read
crm.objects.companies.sensitive.read.v2
crm.objects.tickets.sensitive.write
media_bridge.read
crm.objects.deals.highly_sensitive.read.v2
crm.objects.contacts.highly_sensitive.write.v2
crm.objects.companies.highly_sensitive.read.v2
crm.objects.commercepayments.write
crm.objects.invoices.write
crm.objects.contacts.sensitive.write.v2
crm.objects.calls.read
crm.objects.users.write
crm.objects.meetings.read
crm.objects.custom.sensitive.read.v2
crm.objects.users.read
crm.objects.partner-services.read
crm.objects.orders.write
crm.objects.partner-services.write
crm.objects.appointments.write
crm.objects.projects.highly_sensitive.write
crm.objects.carts.write
crm.objects.tickets.highly_sensitive.write
crm.objects.commercepayments.read
crm.objects.products.write
crm.objects.feedback_submissions.read
crm.objects.services.write
crm.objects.subscriptions.write
crm.objects.deals.sensitive.write.v2
crm.objects.contacts.read
crm.objects.appointments.sensitive.write.v2
crm.objects.projects.highly_sensitive.read
crm.objects.invoices.read
crm.objects.custom.write
tickets.sensitive.v2
crm.objects.deals.write
e-commerce
crm.objects.appointments.read
crm.objects.projects.read
crm.objects.companies.sensitive.write.v2
crm.objects.companies.highly_sensitive.write.v2
crm.objects.deals.highly_sensitive.write.v2
crm.objects.custom.highly_sensitive.read.v2
crm.objects.goals.write
crm.objects.projects.sensitive.read
crm.objects.line_items.write
crm.objects.contacts.write
crm.objects.goals.read
crm.objects.line_items.read
crm.objects.partner-clients.write
crm.objects.projects.write
crm.objects.projects.sensitive.write
crm.objects.deals.sensitive.read.v2
crm.objects.quotes.write
tickets.highly_sensitive.v2
crm.objects.leads.read
crm.objects.leads.write
crm.objects.carts.read
crm.objects.emails.read
crm.objects.quotes.read
crm.objects.courses.write
crm.objects.partner-clients.read
crm.objects.notes.read
crm.objects.courses.read
crm.objects.listings.read
crm.objects.contacts.sensitive.read.v2
crm.objects.products.read

ボディ

application/json

検索リクエストについて説明します

after
string
必須

ページ分割されたレスポンスで次の結果セットを取得するためのページ分割カーソルトークンを表す文字列。

filterGroups
object[]
必須

検索条件を指定するために使用されるフィルターグループの配列。各フィルターグループには、検索結果に含めるためにオブジェクトが満たす必要のある条件を定義する一連のフィルターが含まれています。

limit
integer<int32>
必須

1ページあたりに返す結果の最大数を指定する整数。

properties
string[]
必須

オブジェクトのプロパティーのうち、検索結果に含めるものを示す文字列の配列。

sorts
string[]
必須

検索結果の並べ替えに使用するプロパティーを指定する文字列の配列。

query
string

特定の条件に基づいてオブジェクトを絞り込むための検索クエリーを表す文字列。

レスポンス

successful operation

APIリクエストから返されたシンプルなオブジェクトのリストと、利用可能なオブジェクトの総数を表します。

results
object[]
必須

現在のレスポンスに含まれるSimplePublicObject項目の配列。

total
integer<int32>
必須

表示可能な結果の数

paging
object

APIで結果のリストを移動するためのページ分割情報を表します。前の結果セットまたは次の結果セットにアクセスする方法の詳細を提供します。

最終更新日 2026年10月6日