Campaigns

Retrieve all campaigns

Changed on

Get all campaigns for the authenticated organization.

get/campaign

Request

  • Base URL
    https://api.smallest.ai/atoms/v1
  • URL
    https://api.smallest.ai/atoms/v1/campaign
  • Auth
    HTTP bearer

Query parameters

pageinteger

Page number for pagination

offsetinteger

Number of campaigns per page

status'draft' | 'scheduled' | 'processing' | 'running' | 'paused' | 'completed' | 'failed'

Filter campaigns by status

searchstring

Search campaigns by name

sortField'createdAt' | 'updatedAt'

Field to sort by

sortOrder'asc' | 'desc'

Sort direction

Response

A list of campaigns

statusboolean

Example response

{
  "status": true
}

Changes

    • breaking

      removed the request body

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • info

      added the new optional query request parameter offset

    • info

      added the new optional query request parameter page

    • info

      added the new optional query request parameter search

    • info

      added the new optional query request parameter sortField

    • info

      added the new optional query request parameter sortOrder

    • info

      added the new optional query request parameter status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status