Appearance

List Creatives ​

Endpoint ​

http
GET /unified/ads/creatives
Integrations supported
  • Meta Marketing API

Query parameters ​

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

The format of the response.

  • unified will return the response with unified mappings applied.
  • raw will return the raw response from the remote API.
  • normalized will apply the unified mappings and return the data in a normalized format.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
Example: unified
truto_key_by
string

By default the result attribute is an array of objects. This parameter allows you to specify a field in each result objects to use as key, which transforms the result array into an object with the array items keyed by the field. This is useful for when you want to use the result as a lookup table.

Example: id
truto_ignore_limit
boolean

Ignores the limit query parameter.

truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar
account_id
string

The unique identifier for the account.

Required in
  • Meta Marketing API

Response Body ​

result
object[]

List of Creatives

id
string
REQUIRED · 

The unique identifier for the creative.

Supported in
  • Meta Marketing API
name
string

The name of the creative.

Supported in
  • Meta Marketing API
status
string

The status of the creative.

All possible enum values:
  • active
  • deleted
  • in_process
  • with_issues
Supported in
  • Meta Marketing API
account_id
string

The unique identifier for the account.

Supported in
  • Meta Marketing API
labels
object[]

The labels for the creative.

Supported in
  • Meta Marketing API
id
string

The unique identifier for the label.

name
string

The name of the label.

applink_treatment
string

The applink treatment for the creative.

All possible enum values:
  • automatic
  • deeplink_with_appstore_fallback
  • deeplink_with_web_fallback
  • web_only
Supported in
  • Meta Marketing API
authorization_category
string

The authorization category for the creative.

All possible enum values:
  • none
  • political
Supported in
  • Meta Marketing API
body
string

The body for the creative.

Supported in
  • Meta Marketing API
call_to_action_type
string

The call to action type for the creative.

All possible enum values:
  • open_link
  • like_page
  • shop_now
  • play_game
  • install_app
  • use_app
  • call
  • call_me
  • video_call
  • install_mobile_app
  • use_mobile_app
  • mobile_download
  • book_travel
  • listen_music
  • watch_video
  • learn_more
  • sign_up
  • download
  • watch_more
  • no_button
  • visit_pages_feed
  • apply_now
  • call_now
  • contact
  • buy_now
  • get_offer
  • get_offer_view
  • buy_tickets
  • update_app
  • get_directions
  • buy
  • send_updates
  • message_page
  • donate
  • subscribe
  • say_thanks
  • sell_now
  • share
  • donate_now
  • get_quote
  • contact_us
  • order_now
  • add_to_cart
  • start_order
  • video_annotation
  • record_now
  • inquire_now
  • confirm
  • refer_friends
  • request_time
  • get_showtimes
  • listen_now
  • woodhenge_support
  • sotto_subscribe
  • follow_user
  • raise_money
  • event_rsvp
  • whatsapp_message
  • follow_news_storyline
  • see_more
  • book_now
  • find_a_group
  • find_your_groups
  • pay_to_access
  • purchase_gift_cards
  • follow_page
  • send_a_gift
  • swipe_up_shop
  • swipe_up_product
  • send_gift_money
  • play_game_on_facebook
  • get_started
  • open_instant_app
  • audio_call
  • get_promotions
Supported in
  • Meta Marketing API
image_crops
object

The image crops for the creative.

Supported in
  • Meta Marketing API
image_hash
string

The image hash for the creative.

Supported in
  • Meta Marketing API
image_url
string

The image URL for the creative.

Supported in
  • Meta Marketing API
properties
object[]

The properties for the creative.

Supported in
  • Meta Marketing API
id
string

The unique identifier for the property.

type
string

The type for the property.

url
string

The URL for the property.

spec
object

The spec for the creative.

Supported in
  • Meta Marketing API
interactive_components
object

The interactive components for the creative.

Supported in
  • Meta Marketing API
urls
object[]

The URLs for the creative.

Supported in
  • Meta Marketing API
id
string

The unique identifier for the URL.

type
string

The type for the URL.

url
string

The URL for the URL.

created_at
string · date-time

The date and time the creative was created.

updated_at
string · date-time

The date and time the creative was last updated.

remote_data
object

Raw data returned from the remote API call.

next_cursor
string

The cursor to use for the next page of results. Pass this value as next_cursor in the query parameter in the next request to get the next page of results.