Skip to main content
GET
/
instances
/
{instanceId}
/
token
/
{token}
/
security
/
email
Get account email
curl --request GET \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/security/email \
  --header 'Client-Token: <api-key>'
{
  "success": true,
  "hasEmail": true,
  "email": "<string>",
  "verified": true
}

​
Overview

Method used to get the email configured on a mobile instance’s WhatsApp account.
This API is only available for mobile instances.

​
Attributes

​
instanceId
string
required
Your instance ID. Available in the Z-API panel under Instances.
​
token
string
required
Your Z-API instance token.

​
Response

​
200

​
success
boolean
Returns true if the execution was successful
​
hasEmail
boolean
Whether the account has an email configured
​
email
string
Configured email address
​
verified
boolean
Email verification status
{
  "success": true,
  "hasEmail": true,
  "email": "example@email.com",
  "verified": true
}

​
400

Invalid request. Check if the data you are sending matches the documentation.

​
405

Make sure you are correctly sending the method specification, that is, verify that you sent POST or GET as specified at the beginning of this topic.

​
415

If you receive a 415 error, make sure to add the “Content-Type” header to your request, which in most cases is “application/json”.