Atlas
Admin — Onboarding Emails

Get onboarding email sequence definition

SaaS only. Returns the configured onboarding email sequence steps with triggers and timing.

GET
/api/v1/admin/onboarding-emails/sequence

Response Body

application/json

application/json

application/json

curl -X GET "http://localhost:3001/api/v1/admin/onboarding-emails/sequence"
{
  "enabled": true,
  "steps": [
    {
      "step": "welcome",
      "trigger": "signup_completed",
      "fallbackHours": 0,
      "subject": "string",
      "description": "string"
    }
  ]
}
{
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "message": "string",
  "requestId": "string"
}