Skip to main content
GET
/
instances
/
{instanceId}
/
token
/
{token}
/
broadcast
List broadcast lists
curl --request GET \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/broadcast \
  --header 'Client-Token: <api-key>'

​
Overview

This method allows you to list all broadcast lists associated with your instance, with pagination support.
Please be aware of the limitations and rules around the use of broadcast lists. For more details, check the introduction.

​
Attributes

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

​
Query params (Optional)

​
page
number
Page number to be returned. Starts at 1
​
pageSize
number
Number of items per page. Default: 20

​
Response

​
200

[
  {
    "broadcastId": "1779395073@broadcast",
    "name": "Broadcast list 44",
    "phones": [
        "5511999999999",
        "5511888888888"
    ]
  },
  {
    "broadcastId": "1779395075@broadcast",
    "name": "Broadcast list 45",
    "phones": [
        "5511999999999",
        "5511888888888"
    ]
  }
]

​
405

Make sure you are sending the request with the correct HTTP method. Check that you are using GET as specified at the top of this page.

​
415

If you receive a 415 error, make sure to include the Content-Type header in your request. In most cases, the value should be application/json.