Zum Hauptinhalt springen
GET
/
crm
/
v3
/
objects
/
{objectType}
/
{objectId}
読み取り
curl --request GET \
  --url https://api.hubapi.com/crm/v3/objects/{objectType}/{objectId} \
  --header 'Authorization: Bearer <token>'
{
  "archived": true,
  "archivedAt": "2023-11-07T05:31:56Z",
  "associations": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "objectWriteTraceId": "<string>",
  "properties": {},
  "propertiesWithHistory": {},
  "updatedAt": "2023-11-07T05:31:56Z"
}
次のいずれかの製品またはそれ以上が必要です。
Marketing HubMarketing Hub -無料ツール
Sales HubSales Hub -無料ツール
Service HubService Hub -無料ツール
Content HubContent Hub -無料ツール
この API には、次のいずれかのスコープが必要です。
crm.objects.appointments.read
crm.objects.appointments.sensitive.read.v2
crm.objects.appointments.sensitive.write.v2
crm.objects.appointments.write
crm.objects.carts.read
crm.objects.carts.write
crm.objects.commercepayments.read
crm.objects.commercepayments.write
crm.objects.companies.highly_sensitive.read.v2
crm.objects.companies.highly_sensitive.write.v2
crm.objects.companies.read
crm.objects.companies.sensitive.read.v2
crm.objects.companies.sensitive.write.v2
crm.objects.companies.write
crm.objects.contacts.highly_sensitive.read.v2
crm.objects.contacts.highly_sensitive.write.v2
crm.objects.contacts.read
crm.objects.contacts.sensitive.read.v2
crm.objects.contacts.sensitive.write.v2
crm.objects.contacts.write
crm.objects.courses.read
crm.objects.courses.write
crm.objects.custom.highly_sensitive.read.v2
crm.objects.custom.highly_sensitive.write.v2
crm.objects.custom.read
crm.objects.custom.sensitive.read.v2
crm.objects.custom.sensitive.write.v2
crm.objects.custom.write
crm.objects.deals.highly_sensitive.read.v2
crm.objects.deals.highly_sensitive.write.v2
crm.objects.deals.read
crm.objects.deals.sensitive.read.v2
crm.objects.deals.sensitive.write.v2
crm.objects.deals.write
crm.objects.goals.read
crm.objects.goals.write
crm.objects.invoices.read
crm.objects.invoices.write
crm.objects.leads.read
crm.objects.leads.write
crm.objects.line_items.read
crm.objects.line_items.write
crm.objects.listings.read
crm.objects.listings.write
crm.objects.orders.read
crm.objects.orders.write
crm.objects.partner-clients.read
crm.objects.partner-clients.write
crm.objects.partner-services.read
crm.objects.partner-services.write
crm.objects.products.read
crm.objects.products.write
crm.objects.quotes.read
crm.objects.quotes.write
crm.objects.services.read
crm.objects.services.write
crm.objects.subscriptions.read
crm.objects.subscriptions.write
crm.objects.users.read
crm.objects.users.write
e-commerce
media_bridge.read
oauth
tickets
tickets.highly_sensitive.v2
tickets.sensitive.v2

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
objectId
string
required
​
objectType
string
required

Query Parameters

​
archived
boolean
default:false

アーカイブ済みの結果のみを返すかどうか。

​
associations
string[]

関連付けられているIDを取得するオブジェクトタイプのカンマ区切りリスト。指定された関連付けが存在しない場合は、無視されます。

​
idProperty
string

このオブジェクトについて値が固有のプロパティーの名前

​
properties
string[]

レスポンスで返されるプロパティーのカンマ区切りリスト。指定されたプロパティーがリクエストされたオブジェクトに存在しない場合は、無視されます。

​
propertiesWithHistory
string[]

以前の値の履歴と一緒に返されるプロパティーのカンマ区切りリスト。指定されたプロパティーがリクエストされたオブジェクトに存在しない場合は、無視されます。

Response

successful operation

Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.

​
archived
boolean
required

Whether the object is archived.

​
createdAt
string<date-time>
required

The timestamp when the object was created, in ISO 8601 format.

​
id
string
required

The unique ID of the object.

​
properties
object
required

Key value pairs representing the properties of the object.

​
updatedAt
string<date-time>
required

The timestamp when the object was last updated, in ISO 8601 format.

​
archivedAt
string<date-time>

The timestamp when the object was archived, in ISO 8601 format.

​
associations
object

A list defining relationships with other objects.

​
objectWriteTraceId
string
​
propertiesWithHistory
object

Key-value pairs representing the properties of the object along with their history.