Consultar lista de contatos

Sandbox

GET

/v4/api/contact-lists/{listId}

Retorna uma lista de contatos com seus contatos paginados (page, perPage). Somente leitura; lista inexistente, de outra conta ou invisível ao usuário responsável responde 404.

Requisição

Parâmetros de Caminho

Parâmetros de Consulta

Respostas

🟢200OK

application/json

Sucesso

Headers

Bodyapplication/json

🟠401Não Autorizado

🟠403Proibido

🟠404Registo Não Encontrado

🟠429

Request Example

Shell

JavaScript

Java

Swift

curl --location '/v4/api/contact-lists/?page=undefined&perPage=undefined'

Response Example

200 - Exemplo 1

{
    "id": "string",
    "name": "string",
    "isPublic": true,
    "entriesCount": -9007199254740991,
    "canEdit": true,
    "createdAt": "2019-08-24T14:15:22.123Z",
    "updatedAt": "2019-08-24T14:15:22.123Z",
    "entries": [
        {
            "contactId": "string",
            "order": -9007199254740991,
            "name": "string",
            "email": "string",
            "phoneNumber": "string",
            "role": "string",
            "qualification": "string",
            "deliveryMethod": "string",
            "authMethod": "string",
            "isForeigner": true,
            "mandatoryView": true
        }
    ],
    "meta": {
        "page": 0,
        "perPage": 0,
        "totalPages": 0,
        "totalCount": 0
    }
}

Modificado em 2026-09-28 20:20:50

Página anterior

Listar listas de contatos

Próxima página

Criar contato