Services

Get All Services

get

/v3/services

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

owner_idstringRequired

entity_ownerstringOptional

namestringOptional

Responses

200

The request has succeeded.

application/json

400

The server could not understand the request due to invalid syntax.

application/json

401

Access is unauthorized.

application/json

402

Client error

application/json

403

Access is forbidden.

application/json

404

The server cannot find the requested resource.

application/json

409

The request conflicts with the current state of the server.

application/json

422

Client error

application/json

500

Server error

application/json

502

Server error

application/json

503

Service unavailable.

application/json

504

Server error

application/json

get/v3/services

GET /v3/services?owner_id=text HTTP/1.1
Host: api.squadcast.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "id": "text",
      "name": "text",
      "slug": "text",
      "email": "text",
      "escalation_policy_id": "text",
      "organization_id": "text",
      "api_key": "text",
      "description": "text",
      "depends": [
        "text"
      ],
      "owner": {
        "id": "text",
        "type": "team"
      },
      "on_maintenance": true,
      "slack": {
        "channel_id": "text",
        "name": "text",
        "time": 1
      },
      "escalation_policy": {
        "id": "text",
        "name": "text",
        "description": "text",
        "slug": "text"
      },
      "jira_cloud": {
        "jira_client_key": "text",
        "project": {
          "id": "text",
          "key": "text",
          "name": "text"
        },
        "issue_type": {
          "id": "text",
          "name": "text",
          "statuses": [
            {
              "id": "text",
              "name": "text"
            }
          ]
        },
        "statusmaps": [
          {
            "jira_status": "text",
            "system_status": "text"
          }
        ],
        "is_manual": true
      },
      "maintainer": {
        "id": "text",
        "type": "user"
      },
      "tags": [
        {
          "key": "text",
          "value": "text"
        }
      ],
      "auto_pause_transient_alerts_config": {
        "is_enabled": true,
        "timeout_in_mins": 2
      },
      "intelligent_alerts_grouping_config": {
        "is_enabled": true,
        "rolling_window_in_mins": 5
      },
      "delay_notification_config": {
        "is_enabled": true,
        "timezone": "text",
        "fixed_timeslot_config": {
          "start_time": "text",
          "end_time": "text",
          "repeat_days": [
            1
          ]
        },
        "custom_timeslots_enabled": true,
        "custom_timeslots": {},
        "assigned_to": {
          "id": "text",
          "type": "text"
        }
      },
      "config": {
        "dedup_key_enabled": true
      },
      "created_at": "2026-01-01T00:00:00.000Z",
      "updated_at": "2026-01-01T00:00:00.000Z"
    }
  ]
}

Create Service

post

/v3/services

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

owner_idstringRequired

Body

namestringRequired

owner_idstringRequired

The owner_id is required for POST operations

escalation_policy_idstringRequired

descriptionstringOptional

email_prefixstringOptional

Responses

201

The request has succeeded and a new resource has been created as a result.

application/json

400

The server could not understand the request due to invalid syntax.

application/json

401

Access is unauthorized.

application/json

402

Client error

application/json

403

Access is forbidden.

application/json

404

The server cannot find the requested resource.

application/json

409

The request conflicts with the current state of the server.

application/json

422

Client error

application/json

500

Server error

application/json

502

Server error

application/json

503

Service unavailable.

application/json

504

Server error

application/json

post/v3/services

POST /v3/services?owner_id=text HTTP/1.1
Host: api.squadcast.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 650

{
  "name": "text",
  "owner_id": "text",
  "escalation_policy_id": "text",
  "description": "text",
  "email_prefix": "text",
  "maintainer": {
    "id": "text",
    "type": "user"
  },
  "tags": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "auto_pause_transient_alerts_config": {
    "is_enabled": true,
    "timeout_in_mins": 2
  },
  "intelligent_alerts_grouping_config": {
    "is_enabled": true,
    "rolling_window_in_mins": 5
  },
  "delay_notification_config": {
    "is_enabled": true,
    "timezone": "text",
    "fixed_timeslot_config": {
      "start_time": "text",
      "end_time": "text",
      "repeat_days": [
        1
      ]
    },
    "custom_timeslots_enabled": true,
    "custom_timeslots": {},
    "assigned_to": {
      "id": "text",
      "type": "text"
    }
  },
  "dedup_init_config": {
    "time_window": 1,
    "time_unit": "minute"
  }
}

{
  "data": {
    "id": "text",
    "name": "text",
    "slug": "text",
    "email": "text",
    "escalation_policy_id": "text",
    "organization_id": "text",
    "api_key": "text",
    "description": "text",
    "depends": [
      "text"
    ],
    "owner": {
      "id": "text",
      "type": "team"
    },
    "on_maintenance": true,
    "slack": {
      "channel_id": "text",
      "name": "text",
      "time": 1
    },
    "escalation_policy": {
      "id": "text",
      "name": "text",
      "description": "text",
      "slug": "text"
    },
    "jira_cloud": {
      "jira_client_key": "text",
      "project": {
        "id": "text",
        "key": "text",
        "name": "text"
      },
      "issue_type": {
        "id": "text",
        "name": "text",
        "statuses": [
          {
            "id": "text",
            "name": "text"
          }
        ]
      },
      "statusmaps": [
        {
          "jira_status": "text",
          "system_status": "text"
        }
      ],
      "is_manual": true
    },
    "maintainer": {
      "id": "text",
      "type": "user"
    },
    "tags": [
      {
        "key": "text",
        "value": "text"
      }
    ],
    "auto_pause_transient_alerts_config": {
      "is_enabled": true,
      "timeout_in_mins": 2
    },
    "intelligent_alerts_grouping_config": {
      "is_enabled": true,
      "rolling_window_in_mins": 5
    },
    "delay_notification_config": {
      "is_enabled": true,
      "timezone": "text",
      "fixed_timeslot_config": {
        "start_time": "text",
        "end_time": "text",
        "repeat_days": [
          1
        ]
      },
      "custom_timeslots_enabled": true,
      "custom_timeslots": {},
      "assigned_to": {
        "id": "text",
        "type": "text"
      }
    },
    "config": {
      "dedup_key_enabled": true
    },
    "created_at": "2026-01-01T00:00:00.000Z",
    "updated_at": "2026-01-01T00:00:00.000Z"
  }
}

Get Services By Name

get

/v3/services/by-name

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

namestringRequired

owner_idstringRequired

Responses

200

The request has succeeded.

application/json

400

The server could not understand the request due to invalid syntax.

application/json

401

Access is unauthorized.

application/json

402

Client error

application/json

403

Access is forbidden.

application/json

404

The server cannot find the requested resource.

application/json

409

The request conflicts with the current state of the server.

application/json

422

Client error

application/json

500

Server error

application/json

502

Server error

application/json

503

Service unavailable.

application/json

504

Server error

application/json

get/v3/services/by-name

GET /v3/services/by-name?name=text&owner_id=text HTTP/1.1
Host: api.squadcast.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": {
    "id": "text",
    "name": "text",
    "slug": "text",
    "email": "text",
    "escalation_policy_id": "text",
    "organization_id": "text",
    "api_key": "text",
    "description": "text",
    "depends": [
      "text"
    ],
    "owner": {
      "id": "text",
      "type": "team"
    },
    "on_maintenance": true,
    "slack": {
      "channel_id": "text",
      "name": "text",
      "time": 1
    },
    "escalation_policy": {
      "id": "text",
      "name": "text",
      "description": "text",
      "slug": "text"
    },
    "jira_cloud": {
      "jira_client_key": "text",
      "project": {
        "id": "text",
        "key": "text",
        "name": "text"
      },
      "issue_type": {
        "id": "text",
        "name": "text",
        "statuses": [
          {
            "id": "text",
            "name": "text"
          }
        ]
      },
      "statusmaps": [
        {
          "jira_status": "text",
          "system_status": "text"
        }
      ],
      "is_manual": true
    },
    "maintainer": {
      "id": "text",
      "type": "user"
    },
    "tags": [
      {
        "key": "text",
        "value": "text"
      }
    ],
    "auto_pause_transient_alerts_config": {
      "is_enabled": true,
      "timeout_in_mins": 2
    },
    "intelligent_alerts_grouping_config": {
      "is_enabled": true,
      "rolling_window_in_mins": 5
    },
    "delay_notification_config": {
      "is_enabled": true,
      "timezone": "text",
      "fixed_timeslot_config": {
        "start_time": "text",
        "end_time": "text",
        "repeat_days": [
          1
        ]
      },
      "custom_timeslots_enabled": true,
      "custom_timeslots": {},
      "assigned_to": {
        "id": "text",
        "type": "text"
      }
    },
    "config": {
      "dedup_key_enabled": true
    },
    "created_at": "2026-01-01T00:00:00.000Z",
    "updated_at": "2026-01-01T00:00:00.000Z"
  }
}

Get Service By ID

get

/v3/services/{serviceID}

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

serviceIDstringRequired

Header parameters

authorizationstringRequired

Responses

200

The request has succeeded.

application/json

400

The server could not understand the request due to invalid syntax.

application/json

401

Access is unauthorized.

application/json

402

Client error

application/json

403

Access is forbidden.

application/json

404

The server cannot find the requested resource.

application/json

409

The request conflicts with the current state of the server.

application/json

422

Client error

application/json

500

Server error

application/json

502

Server error

application/json

503

Service unavailable.

application/json

504

Server error

application/json

get/v3/services/{serviceID}

GET /v3/services/{serviceID} HTTP/1.1
Host: api.squadcast.com
Authorization: Bearer YOUR_SECRET_TOKEN
authorization: text
Accept: */*

{
  "data": {
    "id": "text",
    "name": "text",
    "slug": "text",
    "email": "text",
    "escalation_policy_id": "text",
    "organization_id": "text",
    "api_key": "text",
    "description": "text",
    "depends": [
      "text"
    ],
    "owner": {
      "id": "text",
      "type": "team"
    },
    "on_maintenance": true,
    "slack": {
      "channel_id": "text",
      "name": "text",
      "time": 1
    },
    "escalation_policy": {
      "id": "text",
      "name": "text",
      "description": "text",
      "slug": "text"
    },
    "jira_cloud": {
      "jira_client_key": "text",
      "project": {
        "id": "text",
        "key": "text",
        "name": "text"
      },
      "issue_type": {
        "id": "text",
        "name": "text",
        "statuses": [
          {
            "id": "text",
            "name": "text"
          }
        ]
      },
      "statusmaps": [
        {
          "jira_status": "text",
          "system_status": "text"
        }
      ],
      "is_manual": true
    },
    "maintainer": {
      "id": "text",
      "type": "user"
    },
    "tags": [
      {
        "key": "text",
        "value": "text"
      }
    ],
    "auto_pause_transient_alerts_config": {
      "is_enabled": true,
      "timeout_in_mins": 2
    },
    "intelligent_alerts_grouping_config": {
      "is_enabled": true,
      "rolling_window_in_mins": 5
    },
    "delay_notification_config": {
      "is_enabled": true,
      "timezone": "text",
      "fixed_timeslot_config": {
        "start_time": "text",
        "end_time": "text",
        "repeat_days": [
          1
        ]
      },
      "custom_timeslots_enabled": true,
      "custom_timeslots": {},
      "assigned_to": {
        "id": "text",
        "type": "text"
      }
    },
    "config": {
      "dedup_key_enabled": true
    },
    "created_at": "2026-01-01T00:00:00.000Z",
    "updated_at": "2026-01-01T00:00:00.000Z"
  }
}

Update Service

put

/v3/services/{serviceID}

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

serviceIDstringRequired

Body

namestringOptional

escalation_policy_idstringOptional

descriptionstringOptional

email_prefixstringOptional

Responses

200

The request has succeeded.

application/json

400

The server could not understand the request due to invalid syntax.

application/json

401

Access is unauthorized.

application/json

402

Client error

application/json

403

Access is forbidden.

application/json

404

The server cannot find the requested resource.

application/json

409

The request conflicts with the current state of the server.

application/json

422

Client error

application/json

500

Server error

application/json

502

Server error

application/json

503

Service unavailable.

application/json

504

Server error

application/json

put/v3/services/{serviceID}

PUT /v3/services/{serviceID} HTTP/1.1
Host: api.squadcast.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 573

{
  "name": "text",
  "escalation_policy_id": "text",
  "description": "text",
  "email_prefix": "text",
  "maintainer": {
    "id": "text",
    "type": "user"
  },
  "tags": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "auto_pause_transient_alerts_config": {
    "is_enabled": true,
    "timeout_in_mins": 2
  },
  "intelligent_alerts_grouping_config": {
    "is_enabled": true,
    "rolling_window_in_mins": 5
  },
  "delay_notification_config": {
    "is_enabled": true,
    "timezone": "text",
    "fixed_timeslot_config": {
      "start_time": "text",
      "end_time": "text",
      "repeat_days": [
        1
      ]
    },
    "custom_timeslots_enabled": true,
    "custom_timeslots": {},
    "assigned_to": {
      "id": "text",
      "type": "text"
    }
  }
}

{
  "data": {
    "id": "text",
    "name": "text",
    "slug": "text",
    "email": "text",
    "escalation_policy_id": "text",
    "organization_id": "text",
    "api_key": "text",
    "description": "text",
    "depends": [
      "text"
    ],
    "owner": {
      "id": "text",
      "type": "team"
    },
    "on_maintenance": true,
    "slack": {
      "channel_id": "text",
      "name": "text",
      "time": 1
    },
    "escalation_policy": {
      "id": "text",
      "name": "text",
      "description": "text",
      "slug": "text"
    },
    "jira_cloud": {
      "jira_client_key": "text",
      "project": {
        "id": "text",
        "key": "text",
        "name": "text"
      },
      "issue_type": {
        "id": "text",
        "name": "text",
        "statuses": [
          {
            "id": "text",
            "name": "text"
          }
        ]
      },
      "statusmaps": [
        {
          "jira_status": "text",
          "system_status": "text"
        }
      ],
      "is_manual": true
    },
    "maintainer": {
      "id": "text",
      "type": "user"
    },
    "tags": [
      {
        "key": "text",
        "value": "text"
      }
    ],
    "auto_pause_transient_alerts_config": {
      "is_enabled": true,
      "timeout_in_mins": 2
    },
    "intelligent_alerts_grouping_config": {
      "is_enabled": true,
      "rolling_window_in_mins": 5
    },
    "delay_notification_config": {
      "is_enabled": true,
      "timezone": "text",
      "fixed_timeslot_config": {
        "start_time": "text",
        "end_time": "text",
        "repeat_days": [
          1
        ]
      },
      "custom_timeslots_enabled": true,
      "custom_timeslots": {},
      "assigned_to": {
        "id": "text",
        "type": "text"
      }
    },
    "config": {
      "dedup_key_enabled": true
    },
    "created_at": "2026-01-01T00:00:00.000Z",
    "updated_at": "2026-01-01T00:00:00.000Z"
  }
}

Delete Service

delete

/v3/services/{serviceID}

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

serviceIDstringRequired

Header parameters

authorizationstringRequired

Responses

204

There is no content to send for this request, but the headers may be useful.

*/*

objectOptional

400

The server could not understand the request due to invalid syntax.

application/json

401

Access is unauthorized.

application/json

402

Client error

application/json

403

Access is forbidden.

application/json

404

The server cannot find the requested resource.

application/json

409

The request conflicts with the current state of the server.

application/json

422

Client error

application/json

500

Server error

application/json

502

Server error

application/json

503

Service unavailable.

application/json

504

Server error

application/json

delete/v3/services/{serviceID}

DELETE /v3/services/{serviceID} HTTP/1.1
Host: api.squadcast.com
Authorization: Bearer YOUR_SECRET_TOKEN
authorization: text
Accept: */*

{}

Auto Pause Transient Alerts (APTA)

put

/v3/services/{serviceID}/apta-config

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

serviceIDstringRequired

Body

is_enabledbooleanRequired

timeout_in_minsintegerRequired

Responses

200

The request has succeeded.

application/json

400

The server could not understand the request due to invalid syntax.

application/json

401

Access is unauthorized.

application/json

402

Client error

application/json

403

Access is forbidden.

application/json

404

The server cannot find the requested resource.

application/json

409

The request conflicts with the current state of the server.

application/json

422

Client error

application/json

500

Server error

application/json

502

Server error

application/json

503

Service unavailable.

application/json

504

Server error

application/json

put/v3/services/{serviceID}/apta-config

PUT /v3/services/{serviceID}/apta-config HTTP/1.1
Host: api.squadcast.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 39

{
  "is_enabled": true,
  "timeout_in_mins": 1
}

{
  "data": {
    "msg": "text"
  }
}

Intelligent Alert Grouping (IAG)

put

/v3/services/{serviceID}/iag-config

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

serviceIDstringRequired

Body

is_enabledbooleanRequired

rolling_window_in_minsintegerRequired

Responses

200

The request has succeeded.

application/json

400

The server could not understand the request due to invalid syntax.

application/json

401

Access is unauthorized.

application/json

402

Client error

application/json

403

Access is forbidden.

application/json

404

The server cannot find the requested resource.

application/json

409

The request conflicts with the current state of the server.

application/json

422

Client error

application/json

500

Server error

application/json

502

Server error

application/json

503

Service unavailable.

application/json

504

Server error

application/json

put/v3/services/{serviceID}/iag-config

PUT /v3/services/{serviceID}/iag-config HTTP/1.1
Host: api.squadcast.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 46

{
  "is_enabled": true,
  "rolling_window_in_mins": 1
}

{
  "data": {
    "msg": "text"
  }
}

Delayed Notification Config

put

/v3/services/{serviceID}/notification-delay-config

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

serviceIDstringRequired

Body

is_enabledbooleanRequired

timezonestringOptional

custom_timeslots_enabledbooleanOptional

custom_timeslotsobjectOptional

Responses

200

The request has succeeded.

application/json

400

The server could not understand the request due to invalid syntax.

application/json

401

Access is unauthorized.

application/json

402

Client error

application/json

403

Access is forbidden.

application/json

404

The server cannot find the requested resource.

application/json

409

The request conflicts with the current state of the server.

application/json

422

Client error

application/json

500

Server error

application/json

502

Server error

application/json

503

Service unavailable.

application/json

504

Server error

application/json

put/v3/services/{serviceID}/notification-delay-config

PUT /v3/services/{serviceID}/notification-delay-config HTTP/1.1
Host: api.squadcast.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 215

{
  "is_enabled": true,
  "timezone": "text",
  "fixed_timeslot_config": {
    "start_time": "text",
    "end_time": "text",
    "repeat_days": [
      1
    ]
  },
  "custom_timeslots_enabled": true,
  "custom_timeslots": {},
  "assigned_to": {
    "id": "text",
    "type": "text"
  }
}

{
  "data": {
    "id": "text",
    "name": "text",
    "slug": "text",
    "email": "text",
    "escalation_policy_id": "text",
    "organization_id": "text",
    "api_key": "text",
    "description": "text",
    "depends": [
      "text"
    ],
    "owner": {
      "id": "text",
      "type": "team"
    },
    "on_maintenance": true,
    "slack": {
      "channel_id": "text",
      "name": "text",
      "time": 1
    },
    "escalation_policy": {
      "id": "text",
      "name": "text",
      "description": "text",
      "slug": "text"
    },
    "jira_cloud": {
      "jira_client_key": "text",
      "project": {
        "id": "text",
        "key": "text",
        "name": "text"
      },
      "issue_type": {
        "id": "text",
        "name": "text",
        "statuses": [
          {
            "id": "text",
            "name": "text"
          }
        ]
      },
      "statusmaps": [
        {
          "jira_status": "text",
          "system_status": "text"
        }
      ],
      "is_manual": true
    },
    "maintainer": {
      "id": "text",
      "type": "user"
    },
    "tags": [
      {
        "key": "text",
        "value": "text"
      }
    ],
    "auto_pause_transient_alerts_config": {
      "is_enabled": true,
      "timeout_in_mins": 2
    },
    "intelligent_alerts_grouping_config": {
      "is_enabled": true,
      "rolling_window_in_mins": 5
    },
    "delay_notification_config": {
      "is_enabled": true,
      "timezone": "text",
      "fixed_timeslot_config": {
        "start_time": "text",
        "end_time": "text",
        "repeat_days": [
          1
        ]
      },
      "custom_timeslots_enabled": true,
      "custom_timeslots": {},
      "assigned_to": {
        "id": "text",
        "type": "text"
      }
    },
    "config": {
      "dedup_key_enabled": true
    },
    "created_at": "2026-01-01T00:00:00.000Z",
    "updated_at": "2026-01-01T00:00:00.000Z"
  }
}