Get Account

Endpoint used to get the account data linked to the institution.

Request Example

curl --request GET \
  --url https://chat.api.toolzz.com.br/api/v1/auth/myAccount/{adminId} \
  --header 'Authorization: Bearer TOKEN_HERE'

Response Example

{
    "userAccount": {
        "name": "<string>",
        "lastName": "<string>",
        "email": "<string>",
        "phone": "<string>",
        "imgProfile": "<string>",
        "hasPassword": true,
        "hasFinishedOnboarding": true
    }
}

Request description

Access Token

Parameter	Type	Description	Required
Authorization	String	Access token (“Bearer” must be before the token)	Yes

Path Parameters

Parameter	Type	Description	Required
adminId	String	ID of the account administrator	Yes

Note: The adminId can be obtained through the GET Institution endpoint.

---

Response description

Key	Type	Description	Required
id	UUID	Unique and immutable identifier of the user.	Yes
name	String	User’s first name.	Yes
lastName	String	Last name or family name.	Yes
email	String	Email address (must be unique).	Yes
phone	String	Phone number with area code.	No
imgProfileId	String	Unique reference to the image in storage.	No
imgProfile	Array	List of metadata or image paths.	No
hasFinishedOnboarding	Boolean	Defines if the user has already gone through the initial tutorial.	No

---

Security

To access this endpoint, it is necessary to send a valid access token through the authorization header (Authorization) of the request. Additionally, the API is protected by other security measures to safeguard user data.

To access your access token, follow these steps:

1. Log in to the ToolzzAI platform
2. Click on “Settings”
3. Click on “Access Token”
4. Copy the access token