GET
/
crm
/
v3
/
objects
/
users
/
{userId}
読み取り
curl --request GET \
  --url https://api.hubapi.com/crm/v3/objects/users/{userId} \
  --header 'Authorization: Bearer <token>'
{
  "associations": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "archived": true,
  "archivedAt": "2023-11-07T05:31:56Z",
  "propertiesWithHistory": {},
  "id": "<string>",
  "objectWriteTraceId": "<string>",
  "properties": {},
  "updatedAt": "2023-11-07T05:31:56Z"
}
サポートされる製品
次のいずれかの製品またはそれ以上が必要です。
Marketing HubMarketing Hub無料ツール
Sales HubSales Hub無料ツール
Service HubService Hub無料ツール
Content HubContent Hub無料ツール

必須スコープ

この API には、次のいずれかのスコープが必要です。
  • crm.objects.users.read

Authorizations

Authorization
string
header
required

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

Path Parameters

userId
string
required

Query Parameters

properties
string[]

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

propertiesWithHistory
string[]

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

associations
string[]

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

archived
boolean
default:false

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

idProperty
string

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

Response

successful operation

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

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.

associations
object

A list defining relationships with other objects.

archived
boolean

Whether the object is archived.

archivedAt
string<date-time>

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

propertiesWithHistory
object

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

objectWriteTraceId
string