Skip to main content
GET
List CRM object records

Authorizations

X-Api-Key
string
header
required

Headers

X-Workspace-Id
string
required

ワークスペースID

Path Parameters

object
string
required

GET /v2/objects のレスポンスに含まれる data[].name を指定します。 利用できるオブジェクトはワークスペースごとに異なるため、指定できる値はその応答で確認してください。

Query Parameters

limit
integer
default:30

1–100(デフォルト30)

Required range: 1 <= x <= 100
cursor
string

次ページ取得用カーソル

ids
string

取得するレコードの id をカンマ区切りで指定します(最大100件)。各要素は UUID 形式である 必要があり、形式が違う場合は 400 になります。 1リクエストで返る件数は limit(既定 30)に従うため、100件をまとめて取得する場合は limit も指定してください。指定しない場合は 30 件ずつのページングになります。 id の大文字・小文字は区別しません(小文字として扱います)。 公開範囲外・別ワークスペース・削除済みの id は結果から除かれます(エラーにはなりません)。 ids=(空)は 400 になります。

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}(,[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}){0,99}$

関連で絞り込むときの参照元レコードの id です。オブジェクト名は指定しません (一覧対象のオブジェクトから参照経路が決まります)。次の関連を辿ります。

  • company の一覧: 指定した Contact または Deal に紐づく Company
  • contact の一覧: 指定した Company または Deal に紐づく Contact
  • deal の一覧: 指定した Company または Contact に紐づく Deal

UUID 形式である必要があり、形式が違う場合は 400 になります。 id の大文字・小文字は区別しません(小文字として扱います)。 公開範囲外・別ワークスペース・削除済み・関連していないレコードの id を指した場合と、 関連を解除したレコードは、いずれも空の data を返します(404 にはなりません)。

関連を持たないオブジェクト(pipeline / stage)の一覧で指定した場合は 400 です。 ただしそのオブジェクトがワークスペースで利用できない場合は 404 になります。

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Response

成功

data
object[]
required
page_info
object
required

v2 のカーソルページネーション情報。継続判定は has_next_page だけで行ってください。 v1 の pagination.next_cursor と異なり、end_cursor は最終ページでも null になりません。