Sign in

v1

latestOpenAPI 3.0.32026-07-24205887.6 KB
Ad Library

List saved library ads

List ads the calling workspace has saved from the global ad library. Each item carries the standard ad fields plus a saved_details block (saved_at, boards, tags).

Scoped to the workspace bound to your API key. Use the response cursor to paginate.

Returns: code=0 success; code=40001 invalid query parameters.

get/open/v1/ad-library/saved

Query parameters

querystring

Free-text search against ad title, body and brand name.

Free-text search against ad title, body and brand name.

platformOpenAdPlatform[]

Filter by ad platform. Repeatable. Allowed values: facebook, instagram, messenger, audience_network, threads, whatsapp, tiktok, linkedin.

Filter by ad platform. Repeatable. Allowed values: facebook, instagram, messenger, audience_network, threads, whatsapp, tiktok, linkedin.

display_formatOpenAdDisplayFormat[]

Filter by display format. Repeatable. Allowed values: image, video, carousel, multi_images, multi_videos, dco, dpa.

Filter by display format. Repeatable. Allowed values: image, video, carousel, multi_images, multi_videos, dco, dpa.

languagestring[]

Filter by ad copy language (ISO 639-1).

Filter by ad copy language (ISO 639-1).

start_datestring

Inclusive lower bound on ad start date, format YYYY-MM-DD.

Inclusive lower bound on ad start date, format YYYY-MM-DD.

end_datestring

Inclusive upper bound on ad end date, format YYYY-MM-DD.

Inclusive upper bound on ad end date, format YYYY-MM-DD.

statusOpenAdStatus[]

Filter by ad status. Repeatable. Allowed values: active, inactive.

Filter by ad status. Repeatable. Allowed values: active, inactive.

boardsstring[]

Restrict to ads saved in the given board(s). Pass board_id values from GET /open/v1/boards. Repeatable.

Restrict to ads saved in the given board(s). Pass board_id values from GET /open/v1/boards. Repeatable.

tagsstring[]

Restrict to ads tagged with any of the given tag names.

Restrict to ads tagged with any of the given tag names.

order'saved_newest' | 'saved_oldest' | 'newest' | 'oldest' | 'most_active'

An enumeration.

Sort order. saved_newest/saved_oldest use save time; newest/oldest use the ad's start date; most_active is longest currently-running.

page_sizeinteger

Items per page (1-50, default 20).

Items per page (1-50, default 20).

cursorstring

Opaque pagination cursor from the previous response.

Opaque pagination cursor from the previous response.

Response

Successful Response

codeinteger
messagestring