Skip to main content
GET
Get API account information
このページはAIによって自動翻訳されています。API技術仕様は英語が正式です。不明点がある場合は英語版を参照してください。
呼び出しに使用した API キーに対応するアカウントの識別情報——数値の apiId、名称、アカウント種別、主要連絡先メールアドレス、およびアカウントが現在ブロックされているかどうか——を返します。 apiId は、Return Helper がすべての webhook 通知で送信する RETURNHELPER-API-ID ヘッダーと同じ値です。1 台のサーバーで複数の Return Helper アカウントの通知を受信する場合は、API キーごとに本エンドポイントを 1 回ずつ呼び出し、apiId とアカウントの対応表を自社側に保存したうえで、そのヘッダーで各通知を振り分けてください。

承認

x-rr-apikey
string
header
必須

Your API key

x-rr-apitoken
string
header
必須

Your API token — keep this private

レスポンス

Success

apiId
integer<int64>

Identifier of the API account. Sent as the RETURNHELPER-API-ID header on every webhook notification.

:

1234

apiTypeCode
string | null

Account type. Always "USER" for accounts calling the User API.

:

"USER"

apiName
string | null

Account name. Sent as the RETURNHELPER-API-NAME header on every webhook notification.

:

"Acme Returns"

primaryEmail
string | null

Primary contact email of the account.

:

"user@example.com"

isBlocked
boolean

True when the account is blocked and API calls are rejected.