Atlas
Admin — Onboarding Emails

List onboarding email statuses

SaaS only. Returns onboarding email progress for users in the authenticated admin's organization.

GET
/api/v1/admin/onboarding-emails

Query Parameters

limit?string

Max results (default 50)

offset?string

Pagination offset (default 0)

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:3001/api/v1/admin/onboarding-emails"
{
  "enabled": true,
  "statuses": [
    {
      "userId": "string",
      "email": "string",
      "orgId": "string",
      "sentSteps": [
        "welcome"
      ],
      "pendingSteps": [
        "welcome"
      ],
      "unsubscribed": true,
      "createdAt": "string"
    }
  ],
  "total": 0
}
{
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "message": "string",
  "requestId": "string"
}
{
  "error": "string",
  "message": "string",
  "requestId": "string"
}