Zum Hauptinhalt springen
GET
/
settings
/
v3
/
users
/
{userId}
ユーザーが取得されます
curl --request GET \
  --url https://api.hubapi.com/settings/v3/users/{userId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "123",
  "email": "newUser@email.com",
  "roleId": "100",
  "primaryTeamId": "101",
  "secondaryTeamIds": [
    "102"
  ],
  "superAdmin": "false"
}
次のいずれかの製品またはそれ以上が必要です。
Marketing HubMarketing Hub -無料ツール
Sales HubSales Hub -無料ツール
Service HubService Hub -無料ツール
Content HubContent Hub -無料ツール
この API には、次のいずれかのスコープが必要です。
crm.objects.users.read
settings.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

取得するユーザーのID

Query Parameters

​
idProperty
enum<string>

固有のユーザー値を含むプロパティーの名前。有効な値は「USER_ID」（デフォルト）または「EMAIL」です

Verfügbare Optionen:
USER_ID,
EMAIL

Response

successful operation

A user

​
id
string
required

ユーザーの固有ID。

​
email
string
required

ユーザーのEメール。

​
firstName
string

ユーザーの名前。

​
lastName
string

ユーザーの姓。

​
primaryTeamId
string

ユーザーのプライマリーチーム

​
roleIds
string[]

ユーザーに割り当てられた役割IDのリスト。

​
sendWelcomeEmail
boolean

ウェルカムEメールがユーザーに送信されたかどうか。この値は、プロビジョニングリクエストへのレスポンスとしてのみ入力されます。後続のクエリーはfalseになります。

​
roleId
string

ユーザーの役割。

​
secondaryTeamIds
string[]

ユーザーの追加チーム。

​
superAdmin
boolean

ユーザーがスーパー管理者特権を持っているかどうか。