Retrieve Efforts

get

https://{APP_DOMAIN}/api/3.2/marketing/efforts

Returns a paginated list of efforts — trackable marketing touchpoints within a campaign (ads, messages, auto responders, landing pages, etc.). Conditionally loads related models based on requested columns.

Query Params

integer

Filter by effort ID

active

boolean

Filter by active status

name

string

Filter by name

campaign_id

integer

Filter by campaign ID

publication_id

integer

Filter by publication ID

partner_id

integer

Filter by partner ID

ad_id

integer

Filter by ad ID

message_id

integer

Filter by message ID

auto_responder_id

integer

Filter by auto responder ID

promo_id

integer

Filter by promo landing page ID

order_page_id

integer

Filter by order page landing page ID

advertorial_id

integer

Filter by advertorial resource ID

lift_id

integer

Filter by lift letter resource ID

effort_type_id

integer

Filter by effort type ID

type

string

Filter by effort type code

secondary_effort_id

integer

Filter by secondary effort ID

id_with_name

string

Search by ID or name (partial match on both)

created_at

string

Filter by creation date. Supports operators: >, >=, <, <=

updated_at

string

Filter by last updated date. Supports operators: >, >=, <, <=

columns[]

integer

The field to be included in the json response. You can have multiple columns[] query params included in the request URL.

page

integer

The page to return.

per_page

integer

The total results to return per page.

sort

string

The field to sort the request by. column_name|asc OR desc

Response

200

The retrieved efforts

Language

Credentials

Bearer

JWT

URL