Skip to main content
GET
Get CRM object record

Authorizations

X-Api-Key
string
header
required

Headers

X-Workspace-Id
string
required

ワークスペースID

Path Parameters

object
enum<string>
required

GET /v2/objects のレスポンスに含まれる data[].name を指定します。

Available options:
deal,
pipeline,
stage
recordId
string
required

Response

成功

id
string
required
object
enum<string>
required

レコードが属する CRM オブジェクトの API 識別子

Available options:
deal,
pipeline,
stage
Example:

"deal"

visibility
enum<string>
required

レコードの公開範囲です。現在の read API は workspace のレコードのみを返します。

Available options:
workspace,
restricted
Example:

"workspace"

fields
object
required

各キーはオブジェクトメタデータの fields[].name に対応します。 標準フィールドとカスタムフィールドを含み、値の型はフィールドメタデータによって異なります。 MANY_TO_ONE リレーションは *_id 形式のキーで表現されます。

Example:
created_at
string | null
required
updated_at
string | null
required
created_by
object | null
required
updated_by
object | null
required