Saltar para a documentação
API

Listar audiências

Uma audiência é uma lista de contactos com nome neste workspace. Todos os contactos estão na audiência predefinida integrada desde o momento em que existem, e é `builtin` que identifica essa linha; as restantes são suas para criar, encher e apagar. A audiência predefinida vem primeiro, depois as restantes, das mais recentes para as mais antigas. Esta versão gere listas e não lhes envia nada, pelo que não há nenhum endpoint de difusão à espera de ser descoberto.

GETapi.openemail.uk/audiences

Executa a chamada real contra o seu espaço de trabalho, com a sua própria chave.

GET /audiences

Uma audiência é uma lista de contactos com nome neste workspace. Todos os contactos estão na audiência predefinida integrada desde o momento em que existem, e é builtin que identifica essa linha; as restantes são suas para criar, encher e apagar. A audiência predefinida vem primeiro, depois as restantes, das mais recentes para as mais antigas. Esta versão gere listas e não lhes envia nada, pelo que não há nenhum endpoint de difusão à espera de ser descoberto.

Exemplo

Requer audiences:read. limit vai até 100 e assume 25 por omissão.

curl
curl "$OE/audiences" -H "$AUTH"
Resposta
{  "object": "list",  "data": [    {      "object": "audience",      "id": "aud_9f2c4b7e1a0d63d84c5f2e7b",      "name": "All contacts",      "description": null,      "builtin": "default",      "contactCount": 412,      "createdAt": "2026-08-01T10:00:00.000Z",      "updatedAt": "2026-08-01T10:00:00.000Z"    }  ],  "hasMore": false,  "nextCursor": null}

Ramifique por builtin e não pelo nome. A audiência predefinida pode ser renomeada por qualquer pessoa, e o nome é a única coisa nela que muda.

A audiência predefinida é resolvida na primeira leitura, pelo que um workspace que nunca criou uma audiência lista à mesma exatamente uma linha.

contactCount é contado no momento da leitura, pelo que duas leituras antes e depois de uma criação divergem em um. Os nomes não são únicos, por isso guarde ids e não nomes.