Account Information

by Mahalya R | October 10, 2023

How Can We Help?

Last Updated On
Print

This section describes usage of Query APIs to get information of Accounts in HEAL.

Details of All Accounts

To get details of all the accounts that are present in HEAL, use the ‘accounts’ Query API as follows:
API Name – accounts
Format – GET /config/accounts

Output Parameters
Output Type – JSON

  • Id – Id of an account.
  • Name – Name of an account.
  • Identifier – Unique Identifier of an account.
  • Created Time – Time at which account is created in HEAL
  • Updated Time – Time at which account details have been updated.
  • UserIdDetails – Details of the provided user ID.
  • Status – It specifies whether an account is active (1) or not (0).

Details of an Account

To get details for a specific account present in HEAL, use the ‘accounts’ Query API as follows:
API Name – accounts
Format – GET /config/accounts/{accountId}
Input Parameter

TypeNameDescriptionSchemaMandatory / Optional
PathaccountIdID or Identifier of an AccountstringMandatory

 

Output Parameters
Output Type – JSON

  • Id – Id of an account.
  • Name – Name of an account.
  • Identifier – Unique Identifier of an account.
  • Created Time – Time at which account is created in HEAL.
  • Updated Time – Time at which account details have been updated.
  • UserIdDetails – Details of the provided user ID.
  • Status – It specifies whether an account is active (1) or not (0).
Table of Contents