# List Alert Configs

> Pod Engine API endpoint reference, optimized for LLM consumption.
> Auto-generated from the source-of-truth endpoint registry.
>
> Category: Alerts
> Source: https://www.podengine.ai/api-docs/get-alert-configs.md
> Interactive HTML docs: https://www.podengine.ai/api-docs/get-alert-configs
> Full API reference (all endpoints): https://www.podengine.ai/api-docs/llms.txt

**Base URL:** `http://localhost:4000`
**Auth:** Requires a Bearer token: `Authorization: Bearer YOUR_API_KEY`

---

#### GET /api/v1/alerts/alert-configs
**List Alert Configs**

Get all of the team's alert configurations.

```bash
curl -X GET "http://localhost:4000/api/v1/alerts/alert-configs" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"
```

**Query schema:**
```json
{
  "type": "object",
  "properties": {
    "enabled": {
      "type": "boolean"
    },
    "alertConfigId": {
      "type": "string"
    },
    "sortBy": {
      "type": "string",
      "enum": [
        "lastRunDate",
        "alertName"
      ]
    },
    "sortDirection": {
      "type": "string",
      "enum": [
        "asc",
        "desc"
      ]
    }
  },
  "additionalProperties": false
}
```

**Response schema:**
```json
{
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "OK"
      ]
    },
    "data": {
      "type": "object",
      "properties": {
        "options": {
          "type": "object",
          "properties": {
            "enabled": {
              "type": "boolean"
            },
            "alertConfigId": {
              "type": "string"
            },
            "sortBy": {
              "type": "string",
              "enum": [
                "lastRunDate",
                "alertName"
              ]
            },
            "sortDirection": {
              "type": "string",
              "enum": [
                "asc",
                "desc"
              ]
            }
          },
          "additionalProperties": false
        },
        "alertConfigs": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "createdByUserId": {
                "type": "string"
              },
              "teamId": {
                "type": "string"
              },
              "createdAt": {},
              "updatedAt": {},
              "alertName": {
                "type": "string"
              },
              "alertType": {
                "type": "string",
                "enum": [
                  "person",
                  "company",
                  "custom-keyword"
                ]
              },
              "enabled": {
                "type": "boolean"
              },
              "alertSettings": {
                "allOf": [
                  {
                    "oneOf": [
                      {
                        "type": "object",
                        "properties": {
                          "type": {
                            "type": "string",
                            "enum": [
                              "person"
                            ]
                          },
                          "value": {
                            "type": "string"
                          },
                          "trackGuestAppearances": {
                            "type": "boolean"
                          },
                          "trackHostAppearances": {
                            "type": "boolean"
                          },
                          "trackMentions": {
                            "type": "boolean"
                          }
                        },
                        "required": [
                          "type",
                          "value"
                        ],
                        "additionalProperties": false
                      },
                      {
                        "type": "object",
                        "properties": {
                          "type": {
                            "type": "string",
                            "enum": [
                              "company"
                            ]
                          },
                          "value": {
                            "type": "string"
                          }
                        },
                        "required": [
                          "type",
                          "value"
                        ],
                        "additionalProperties": false
                      },
                      {
                        "type": "object",
                        "properties": {
                          "type": {
                            "type": "string",
                            "enum": [
                              "custom-keyword"
                            ]
                          },
                          "value": {
                            "type": "string"
                          }
                        },
                        "required": [
                          "type",
                          "value"
                        ],
                        "additionalProperties": false
                      }
                    ]
                  },
                  {
                    "type": "object",
                    "properties": {
                      "genresToSkip": {
                        "type": "array",
                        "items": {
                          "type": "string"
                        }
                      },
                      "genresToInclude": {
                        "type": "array",
                        "items": {
                          "type": "string"
                        }
                      },
                      "otherSpellings": {
                        "type": "array",
                        "items": {
                          "type": "string"
                        }
                      },
                      "otherEmails": {
                        "type": "array",
                        "items": {
                          "type": "string",
                          "format": "email",
                          "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
                        }
                      },
                      "contextAwareQuestion": {
                        "type": "string"
                      },
                      "contextAwareDetails": {
                        "type": "object",
                        "properties": {
                          "what": {
                            "type": "string"
                          },
                          "relevantClues": {
                            "type": "string"
                          },
                          "commonFalsePositives": {
                            "type": "string"
                          }
                        },
                        "additionalProperties": false
                      },
                      "filterAdvertisements": {
                        "type": "boolean"
                      }
                    },
                    "additionalProperties": false
                  }
                ]
              },
              "emailSettings": {
                "type": "object",
                "properties": {
                  "frequency": {
                    "type": "string",
                    "enum": [
                      "hourly",
                      "daily",
                      "weekly"
                    ]
                  }
                },
                "required": [
                  "frequency"
                ],
                "additionalProperties": false
              },
              "lastRunDate": {
                "nullable": true
              }
            },
            "required": [
              "id",
              "createdByUserId",
              "teamId",
              "createdAt",
              "updatedAt",
              "alertName",
              "alertType",
              "enabled",
              "alertSettings",
              "emailSettings",
              "lastRunDate"
            ],
            "additionalProperties": false
          }
        }
      },
      "required": [
        "options",
        "alertConfigs"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "status",
    "data"
  ],
  "additionalProperties": false
}
```

---

## See also

- All endpoints in one file: https://www.podengine.ai/api-docs/llms.txt
- Full reference with every schema inlined: https://www.podengine.ai/api-docs/llms-full.txt
- OpenAPI 3.1 spec: https://www.podengine.ai/api-docs/openapi.json
- Get an API key: https://www.podengine.ai/get-started
- Support: support@podengine.ai