> ## Documentation Index
> Fetch the complete documentation index at: https://developer.z-api.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Listar seguidores do canal

> Retorna a lista completa de seguidores do canal

## Conceituação

Este método retorna a lista completa de seguidores do canal.

***

## Atributos

### Header

<ParamField path="instanceId" type="string" required>
  ID da sua instância. Disponível no painel Z-API em **Instâncias**.
</ParamField>

<ParamField path="token" type="string" required>
  Token da sua instância Z-API.
</ParamField>

### Path

<ParamField path="newsletterId" type="string" required>
  ID do canal
</ParamField>

***

## Response

### 200

Retorna um array de objetos de seguidores.

<ResponseField name="id" type="string">
  ID do seguidor (pode ser um número de telefone ou um `@lid`)
</ResponseField>

<ResponseField name="phoneNumber" type="string">
  Número de telefone do seguidor, quando disponível
</ResponseField>

<ResponseField name="displayName" type="string">
  Nome de exibição do seguidor, quando disponível
</ResponseField>

<ResponseField name="username" type="string">
  Nome de usuário do seguidor, quando disponível
</ResponseField>

<ResponseField name="role" type="string">
  Papel do seguidor no canal (OWNER, ADMIN ou SUBSCRIBER)
</ResponseField>

<ResponseField name="followTime" type="number">
  Timestamp de quando o usuário começou a seguir o canal, quando disponível
</ResponseField>

<ResponseField name="adminProfile" type="object">
  Informações do perfil de admin do seguidor, quando ele for admin do canal

  <Expandable title="Propriedades">
    <ResponseField name="id" type="string">
      ID do admin
    </ResponseField>

    <ResponseField name="name" type="string">
      Nome do admin
    </ResponseField>

    <ResponseField name="pictureDirectPath" type="string">
      Caminho da imagem de perfil do admin, quando disponível
    </ResponseField>
  </Expandable>
</ResponseField>

```json theme={"theme":{"light":"github-light","dark":"poimandres"}}
[
  {
    "id": "199690293383294@lid",
    "phoneNumber": null,
    "displayName": null,
    "username": null,
    "role": "SUBSCRIBER",
    "followTime": null,
    "adminProfile": null
  },
  {
    "id": "277454937673921@lid",
    "phoneNumber": null,
    "displayName": null,
    "username": null,
    "role": "SUBSCRIBER",
    "followTime": null,
    "adminProfile": null
  }
]
```

<Info>
  O ID do canal sempre deve conter o sufixo **@newsletter**, pois esse é o padrão utilizado pelo próprio WhatsApp.
</Info>

<Info>
  O WhatsApp só retorna os seguidores que estiverem na lista de contatos de quem realizou a requisição, e é necessário que quem realiza a requisição seja admin do canal. Essa listagem não possui paginação, retornando todos os seguidores disponíveis em uma única resposta.
</Info>

### 405

Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja verifique se você enviou o POST ou GET conforme especificado no início deste tópico.

### 415

Caso você receba um erro 415, certifique de adicionar na headers da requisição o "Content-Type" do objeto que você está enviando, em sua grande maioria "application/json".