> For the complete documentation index, see [llms.txt](https://outboundpro.gitbook.io/api-v1/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://outboundpro.gitbook.io/api-v1/list/listar-listas.md). # Listar listas ## Listar todas as listas de leads do cliente > Retorna paginação de todas as \*\*listas\*\* do cliente — tanto as públicas\ > (compartilhadas com toda a empresa) quanto as privadas do usuário autenticado.\ > \ > Listas são containers usados pra organizar leads em \*\*grupos lógicos\*\* (por\ > campanha, persona, vertical, fase do funil, etc). Cada lead pode pertencer\ > a uma única lista por vez.\ > \ > \### Quando usar\ > \- \*\*Sincronização inicial\*\* com CRM externo — busca todas as listas e replica\ > a hierarquia/segmentação.\ > \- \*\*Picker de UI\*\* no app do cliente — popula um dropdown com as listas\ > disponíveis pra mover leads.\ > \- \*\*Análise de cobertura\*\* — quantas listas tem? quantos leads por lista?\ > (combine com \`/lead/list?lista\_id=X\`).\ > \ > \### Casos de uso reais\ > \- \*\*CRM com filtro hierárquico\*\*: cliente seleciona uma lista no dropdown do\ > Salesforce, sistema chama \`/lead/list?lista\_id=N\` pra puxar só os leads daquela campanha.\ > \- \*\*Onboarding automático\*\*: ao plugar API pela primeira vez, integração baixa\ > todas as listas + leads e replica no sistema do cliente.\ > \- \*\*Backup automatizado\*\*: cron diário lista as listas + busca os leads de cada\ > uma, salva em JSON num bucket S3.
```json {"openapi":"3.0.3","info":{"title":"OutboundPro API","version":"2.0.0"},"tags":[{"name":"List","description":"**Listas de leads** — agrupamentos arbitrários que você cria para\norganizar prospecção (ex.: \"E-commerces SP\", \"Tecnologia ENT\", \"Black Friday 2026\").\n\nListas podem ser **públicas** (compartilhadas com todo o cliente) ou\n**privadas** (só você), ter **prevendedor** designado, cor customizada,\ne **seguidores** (usuários que recebem notificação de movimento).\n\n### Operações suportadas\n- CRUD completo (list, search, create, edit, delete).\n- Exclusão é **lógica** (soft delete; `lis_excluida = 'S'`).\n- Buscar com filtros: nome, tipo, público/privado, dono, prevendedor, período.\n"}],"servers":[{"url":"https://app.outboundpro.com.br/api","description":"Produção"}],"security":[{"TokenAuth":[]}],"components":{"securitySchemes":{"TokenAuth":{"type":"apiKey","in":"header","name":"Token","description":"Chave privada do cliente (`cli_chave_privada`). Formato UUID v4\n(36 caracteres com hífens). Aceita header em qualquer case\n(`Token`, `token`, `TOKEN`).\n"}},"schemas":{"PaginacaoEnvelope":{"type":"object","required":["response","total","pagina","limite","paginas"],"properties":{"response":{"type":"string","enum":["success"]},"total":{"type":"integer","description":"Total geral (ignora paginação)."},"pagina":{"type":"integer","minimum":1},"limite":{"type":"integer","minimum":1,"maximum":100},"paginas":{"type":"integer","description":"Total de páginas considerando `limite` atual."}}},"Lista":{"type":"object","properties":{"id":{"type":"integer"},"codigo_ficticio":{"type":"integer","description":"Código curto para exibição (não use em joins; use `id`)."},"nome":{"type":"string"},"publica":{"type":"string","enum":["S","N"],"description":"S = compartilhada com todo o cliente, N = privada."},"cor_fundo":{"type":"string"},"cor_texto":{"type":"string"},"tipo":{"type":"string"},"prevendedor_id":{"type":"integer","nullable":true,"description":"Usuário responsável pela prospecção da lista."},"seguidores":{"type":"array","description":"Usuários que recebem notificação quando lead é movido na lista.","items":{"type":"object","properties":{"id":{"type":"integer"},"nome":{"type":"string"},"email":{"type":"string","format":"email"}}}},"data_cadastro":{"type":"string","format":"date-time"}}},"ErrorResponse":{"type":"object","required":["response"],"properties":{"response":{"type":"string","enum":["error"]},"mensagem":{"type":"string","description":"Descrição do erro em pt-BR. Família Contact usa `message` (legado)."},"message":{"type":"string","description":"Equivalente inglês de `mensagem`, usado pela família Contact."}}}},"responses":{"Unauthorized":{"description":"Token ausente, inválido ou cliente inativo.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/list/list":{"get":{"tags":["List"],"summary":"Listar todas as listas de leads do cliente","operationId":"listList","description":"Retorna paginação de todas as **listas** do cliente — tanto as públicas\n(compartilhadas com toda a empresa) quanto as privadas do usuário autenticado.\n\nListas são containers usados pra organizar leads em **grupos lógicos** (por\ncampanha, persona, vertical, fase do funil, etc). Cada lead pode pertencer\na uma única lista por vez.\n\n### Quando usar\n- **Sincronização inicial** com CRM externo — busca todas as listas e replica\n a hierarquia/segmentação.\n- **Picker de UI** no app do cliente — popula um dropdown com as listas\n disponíveis pra mover leads.\n- **Análise de cobertura** — quantas listas tem? quantos leads por lista?\n (combine com `/lead/list?lista_id=X`).\n\n### Casos de uso reais\n- **CRM com filtro hierárquico**: cliente seleciona uma lista no dropdown do\n Salesforce, sistema chama `/lead/list?lista_id=N` pra puxar só os leads daquela campanha.\n- **Onboarding automático**: ao plugar API pela primeira vez, integração baixa\n todas as listas + leads e replica no sistema do cliente.\n- **Backup automatizado**: cron diário lista as listas + busca os leads de cada\n uma, salva em JSON num bucket S3.\n","parameters":[{"in":"query","name":"pagina","schema":{"type":"integer","default":1,"minimum":1}},{"in":"query","name":"limite","schema":{"type":"integer","default":50,"minimum":1,"maximum":100}},{"in":"query","name":"ordenacao","schema":{"type":"string","default":"lis_data_cadastro"}},{"in":"query","name":"direcao","schema":{"type":"string","enum":["ASC","DESC"],"default":"DESC"}}],"responses":{"200":{"description":"Listas paginadas.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PaginacaoEnvelope"},{"type":"object","properties":{"listas":{"type":"array","items":{"$ref":"#/components/schemas/Lista"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"}}}}}} ```