# Search Email Signatures

Searches email signatures by name with sender readiness, selection tags and business-card availability (required by add-email-editor-contact-card). Unusable signatures are excluded unless includeUnusable is true, which also returns blockers. Content is read by get-signature; to select signatures automatically by tags, pass signature ID 0 to configure-newsletter-delivery.

## Input schema:

```json
{
  "type": "object",
  "properties": {
    "query": {
      "type": [
        "null",
        "string"
      ],
      "description": "Text the name of a signature has to contain; omit to list them all",
      "default": null,
      "maxLength": 250
    },
    "includeUnusable": {
      "type": [
        "null",
        "boolean"
      ],
      "description": "True to also return signatures that cannot currently be used, with their blockers; omit to leave them out",
      "default": null
    },
    "limit": {
      "type": [
        "null",
        "integer"
      ],
      "description": "How many signatures to return at most, 1 to 200, 50 by default",
      "default": null,
      "minimum": 1,
      "maximum": 200
    },
    "accountId": {
      "type": [
        "null",
        "integer"
      ],
      "description": "User ID of the account to list signatures for; omit for the token account, or pass an accessible subaccount ID",
      "default": null,
      "minimum": 1
    }
  },
  "additionalProperties": false
}
```

## Output schema:

```json
{
  "type": "object",
  "required": [
    "accountId",
    "count",
    "totalCount",
    "hasMore",
    "unusableCount",
    "signatures"
  ],
  "properties": {
    "accountId": {
      "type": "integer"
    },
    "count": {
      "type": "integer"
    },
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "unusableCount": {
      "type": "integer"
    },
    "signatures": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "signatureId",
          "name",
          "isDefault",
          "senderName",
          "senderEmail",
          "effectiveSenderEmail",
          "senderIdentityStatus",
          "senderAddressStatus",
          "tagIds",
          "isUsable",
          "blockers",
          "hasVCardData",
          "editUrl"
        ],
        "properties": {
          "signatureId": {
            "type": "integer"
          },
          "name": {
            "type": "string"
          },
          "isDefault": {
            "type": "boolean"
          },
          "senderName": {
            "type": "string"
          },
          "senderEmail": {
            "type": "string"
          },
          "effectiveSenderEmail": {
            "type": "string"
          },
          "senderIdentityStatus": {
            "type": "string",
            "enum": [
              "ready",
              "address-not-configured",
              "address-not-confirmed",
              "address-not-usable",
              "address-blocked",
              "domain-not-configured",
              "domain-not-verified",
              "domain-not-yet-usable",
              "domain-mismatch"
            ]
          },
          "senderAddressStatus": {
            "type": "string",
            "enum": [
              "",
              "dkim-valid",
              "not-confirmed",
              "no-domain",
              "dkim-invalid",
              "not-configured"
            ]
          },
          "tagIds": {
            "type": "array",
            "items": {
              "type": "integer"
            }
          },
          "isUsable": {
            "type": "boolean"
          },
          "blockers": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "hasVCardData": {
            "type": "boolean"
          },
          "editUrl": {
            "type": "string"
          }
        }
      }
    }
  }
}
```