Saltar para a documentação
API

Listar assinaturas

Todas as assinaturas do espaço de trabalho, ou as de um endereço.

GET/signatures

Executa a chamada real no seu espaço de trabalho.

GET /signatures

Todas as assinaturas do espaço de trabalho, ou as de um endereço.

Exemplo

Requer settings:read. Um endereço guarda uma lista de assinaturas com nome. Sem address, a lista tem todos os endereços, ordenada por endereço e depois das mais antigas para as mais recentes. Com ele, apenas as assinaturas desse endereço, ou as de um catch-all escrito *@acme.com.

curl
curl "$OE/[email protected]" -H "$AUTH"
Resposta
{  "object": "list",  "data": [    {      "object": "signature",      "id": "sig_2b7e9c41d0a54f3e8c6d1a90",      "address": "[email protected]",      "name": "Work",      "html": "<p>Ada Lovelace<br />Head of Research, Acme Ltd</p>",      "isDefault": true,      "isReplyDefault": false,      "createdAt": "2026-09-02T08:14:03.117Z",      "updatedAt": "2026-10-01T10:05:12.031Z"    },    {      "object": "signature",      "id": "sig_8f2c1a9b7d3e4f60a1b2c3d4",      "address": "[email protected]",      "name": "Short",      "html": "<p>Ada<br />Acme Ltd</p>",      "isDefault": false,      "isReplyDefault": true,      "createdAt": "2026-10-12T09:14:03.117Z",      "updatedAt": "2026-10-12T09:14:03.117Z"    }  ],  "hasMore": false,  "nextCursor": null}

isDefault marca a assinatura que o correio novo do endereço leva, e isReplyDefault a que levam as suas respostas e reencaminhamentos. No máximo uma assinatura de um endereço tem cada um, uma assinatura pode ter os dois, e um endereço pode não ter nenhum.

A lista pagina com limit e cursor, como todas as listas. Um endereço que só teve a assinatura única das versões anteriores mostra-a como uma assinatura chamada Signature, predefinida para ambos.

Uma chave ou uma aplicação limitada a certos endereços ou domínios alcança apenas as assinaturas dos endereços que tem, e as de um catch-all só quando tem o domínio inteiro.

Referência