Skip to content

Campaigns List ​

lindris campaigns list

List campaigns

Synopsis ​

GET /api/campaigns — paginated.

--status takes ONE status (draft, sent, scheduled, sending, paused, failed) or "all" for every status; it defaults to draft. A comma-separated list is rejected by the API. The status shown for a campaign may be a computed sub-state (e.g. "preparing") that is not itself filterable.

--sort (name, createdAt, status) and --order (asc, desc) are passed through. With no --sort the backend applies its own default ordering for the requested status.

bash
lindris campaigns list [flags]

Examples ​

bash
$ lindris campaigns list
$ lindris campaigns list --status=all --sort=createdAt --order=desc
$ lindris campaigns list --status=sent | jq -r '.data[].id'
$ lindris campaigns list --output=text

Options ​

  • --order string - Sort direction: asc|desc (ignored unless --sort is set)
  • -o, --output string - Output format: json|text. Default: json
  • --page int - Page number (omit for page 1; the API rejects anything above 10000)
  • --per-page int - Results per page. Default: 10; values above 100 are clamped to 100, not rejected
  • --sort string - Sort field: name|createdAt|status. Default: backend's per-status order
  • --status string - Status filter — one of draft|sent|scheduled|sending|paused|failed, or all. Default: draft

See Also ​