Get API account information
Api
Get API account information
GET
Get API account information
Returns the identity of the account behind the API key you called with — its numeric
apiId, name, account type, primary contact email, and whether the account is currently blocked.
apiId is the same value Return Helper sends in the RETURNHELPER-API-ID header on every webhook notification. If one server receives notifications for more than one Return Helper account, call this endpoint once per API key, store the apiId → account mapping on your side, and route each incoming notification by that header.
Related
- Webhooks → Notification Headers — where
apiIdappears on incoming notifications. - List notification endpoints — the notification endpoints registered for this account.
Authorizations
Your API key
Your API token — keep this private
Response
Success
Identifier of the API account. Sent as the RETURNHELPER-API-ID header on every webhook notification.
Example:
1234
Account type. Always "USER" for accounts calling the User API.
Example:
"USER"
Account name. Sent as the RETURNHELPER-API-NAME header on every webhook notification.
Example:
"Acme Returns"
Primary contact email of the account.
Example:
"user@example.com"
True when the account is blocked and API calls are rejected.