List e-mail integrations

Returns a list of all your e-mail integrations.

GET https://incidents.betterstack.com/api/v2/email-integrations

Query parameters

team_name
string
page
integer
per_page
integer

Headers

Authorization
required string
200

Response body

{
  "data": [
    {
      "id": "13760",
      "type": "email_integration",
      "attributes": {
        "name": "Test",
        "created_at": "2023-01-20T09:18:47.361Z",
        "updated_at": "2023-01-20T09:18:47.361Z",
        "policy_id": null,
        "team_name": "Testing",
        "call": false,
        "sms": false,
        "email": true,
        "push": true,
        "critical_alert": false,
        "team_wait": 180,
        "recovery_period": 0,
        "email_address": "test@incidents.uptime.betterstack.com",
        "paused": false,
        "started_rule_type": "unused",
        "acknowledged_rule_type": "unused",
        "resolved_rule_type": "unused",
        "started_rules": [],
        "acknowledged_rules": [],
        "resolved_rules": [],
        "cause_field": {
          "name": null,
          "special_type": "cause",
          "field_target": "subject",
          "match_type": "match_everything",
          "content": null,
          "content_before": null,
          "content_after": null
        },
        "title_field": null,
        "started_alert_id_field": null,
        "acknowledged_alert_id_field": null,
        "resolved_alert_id_field": null,
        "other_started_fields": null,
        "other_acknowledged_fields": null,
        "other_resolved_fields": null
      }
    }
  ],
  "pagination": {
    "first": "https://incidents.betterstack.com/api/v2/email-integrations?page=1",
    "last": "https://incidents.betterstack.com/api/v2/email-integrations?page=1",
    "prev": null,
    "next": null
  }
}

Response attributes

id
string
type
string
attributes.name
string or null
attributes.created_at
string
attributes.updated_at
string
attributes.policy_id
string or null
attributes.team_name
string
attributes.call
boolean
attributes.sms
boolean
attributes.email
boolean
attributes.push
boolean
attributes.critical_alert
boolean
attributes.team_wait
integer or null
attributes.recovery_period
integer
attributes.email_address
string
attributes.paused
boolean
attributes.started_rule_type
string
attributes.acknowledged_rule_type
string
attributes.resolved_rule_type
string
attributes.started_rules
array
attributes.started_rules[].created_at
string
attributes.started_rules[].updated_at
string
attributes.started_rules[].rule_target
string
attributes.started_rules[].match_type
string
attributes.started_rules[].content
string
attributes.acknowledged_rules
array
attributes.resolved_rules
array
attributes.cause_field
object or null
attributes.cause_field.name
string or null
attributes.cause_field.special_type
string or null
attributes.cause_field.field_target
string
attributes.cause_field.match_type
string
attributes.cause_field.content
string or null
attributes.cause_field.content_before
string or null
attributes.cause_field.content_after
string or null
attributes.title_field
object or null
attributes.started_alert_id_field
object or null
attributes.acknowledged_alert_id_field
object or null
attributes.resolved_alert_id_field
object or null
attributes.other_started_fields
array or null
attributes.other_acknowledged_fields
array or null
attributes.other_resolved_fields
array or null
pagination.first
string
pagination.last
string
pagination.prev
string or null
pagination.next
string or null

Example cURL

Example
curl --request GET \
  --url https://incidents.betterstack.com/api/v2/email-integrations \
  --header "Authorization: Bearer $TOKEN"