Skip to main content
GET
/
instances
/
{instanceId}
/
token
/
{token}
/
privacy
/
disallowed-contacts
List disallowed contacts
curl --request GET \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/privacy/disallowed-contacts \
  --header 'Client-Token: <api-key>'
{
  "disallowedContacts": [
    {}
  ]
}

​
Overview

Through this method, you can list the contacts that are on the disallowed list (blacklist) for certain interactions with your account.

​
Attributes

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

​
Query Parameters

​
type
string
required
Defines the blocking scope: lastSeen, photo, description or groupAdd

​
Response

​
200

​
disallowedContacts
array
List of blocked phone numbers
{
  "disallowedContacts": [
    "554411111111",
    "554422222222"
  ]
}

​
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”.