List campaigns

List campaigns for the authenticated user's own company (paginated), with status/search filtering and sorting.

Auth: Account — authentication, under the ACCOUNT-scope route group. Scoped to (the caller's own company); no partner-tree walk. If the user has assign_location set with assigned stores, results are further restricted to store_id IN (assignedStores).

Rate limit: No rate limit.

Request

  • Query: status (string, optional) — one of draft, active (becomes scheduled/in_progress), inactive (becomes completed/paused/cancelled).
  • Query: page (integer, optional) — min 1.
  • Query: per_page (integer, optional) — 10–100 (values below 10 are raised to 10), default 15.
  • Query: search_field (string, optional) — one of name, description, store_name, store_id, storeId, type (paired with search_value).
  • Query: search_value (string, optional) — max 255.
  • Query: sort_field (string, optional) — one of name, status, created_at, updated_at, scheduled_at, started_at, completed_at, request_file_status, request_per_day, request_frequency, request_delay, next_execution_time, total_audience, total_valid_phones, total_valid_emails, store_name, storeId, type (default created_at).
  • Query: sort_by (string, optional) — asc/ASC/desc/DESC (default DESC).
  • Query: location_id (integer, optional) — Must be an existing location; filters to a single store.

Response{ data. } envelope; data is a paginator whose data array items are.

  • data.data[] (array) — campaign rows; each item:
  • id, store_id, user_id (int)
  • name, description, status, current_step — campaign basics
  • scheduled_at, started_at, completed_at, created_at, updated_at, next_execution_time (datetime|null)
  • total_audience, total_valid_phones, total_valid_emails (int) — non-test counts
  • request_file_name, request_file_status, request_per_day, request_frequency, request_delay, request_after_time, send_immediately (bool), type
  • channels[]{ id, rs_campaign_id, channel_type, is_enabled(bool), template_id, errors[], landing_page{} }
  • store (object|null) — { id, name, storeId, clientLocationId }
  • request_file_url (string|null), unique_code (string|null)
  • has_sms_channel (bool), has_email_channel (bool), is_active (bool)
  • data.current_page, data.per_page, data.total, data.last_page, data.from, data.to, data.first_page_url, data.last_page_url, data.prev_page_url, data.next_page_url, data.path, data.links[] — standard pagination meta.

Errors: 422 on validation failure.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Response

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json