List alerts

List alerts owned by the given project, newest first.

GET /v1/projects/{projectId}/alerts

cURL

cURL

curl -H "X-API-Key: $PARTICLE_API_KEY" \
  "https://api.particle.pro/v1/projects/{projectId}/alerts?limit=25"

200

{
  "data": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "delivery_cadence": "<string>",
      "entities": [
        {
          "entity_id": "<string>",
          "entity_type": "PERSON",
          "image_url": "<string>",
          "name": "<string>"
        }
      ],
      "id": "<string>",
      "is_active": true,
      "kind": "ENTITY_MENTION",
      "notifications": [
        {
          "type": "EMAIL",
          "created_by": {
            "id": "<string>",
            "name": "<string>"
          },
          "email": "[e-mail]",
          "id": "<string>",
          "slack_channel_id": "<string>",
          "slack_channel_name": "<string>",
          "slack_connection_id": "<string>",
          "webhook_connection_id": "<string>"
        }
      ],
      "project_id": "<string>",
      "title": "<string>",
      "updated_at": "2023-11-07T05:31:56Z",
      "created_by": {
        "id": "<string>",
        "name": "<string>"
      },
      "description": "<string>",
      "filters": {
        "languages": [
          "<string>"
        ],
        "relevance": "EVERYTHING",
        "source_popularity": "ANY",
        "speaker_roles": [
          "HOST"
        ]
      }
    }
  ],
  "has_more": true,
  "cursor": "<string>"
}

Authorizations

ApiKeyHeaderBearerAuth

X-API-Key · string · header · required

Pass your API key in the X-API-Key header (recommended).

Path Parameters

projectId · string · required

Project ID.

Query Parameters

limit · integer<int64> · default: 25

Results per page

Required range: 1 <= x <= 100

cursor · string

Opaque pagination cursor from previous response

Response

200

application/json

OK

data · object[] | null · required

List of results

Show child attributes

has_more · boolean · required

Whether more results exist

cursor · string

Pass to next request for more results