TOOL API

page_get

Gets page IDs and page records from /open_api/v1.3/page/get/ so you can use the returned `page_id` in ads. Retrieve pages either under an ad account by passing `advertiser_id`, or under a Business Center form library by passing `library_id`. This page also notes the v1.2 to v1.3 migration changes: the endpoint path changed from `/v1.2/pages/get/` to `/v1.3/page/get/`, and several request and response ID/time fields changed from number to string types in v1.3.

ecommerceOAuth1 credits

Call information

Tool slug
tiktok-ads.page_get
Provider
TikTok for Business
Average response
0 ms
Calls in 7 days
0

Input parameters

advertiser_id

Either `advertiser_id` or `library_id` must be set. Use this field to get pages under an ad account.

business_type

Filter by a single page type. Default value: `LEAD_GEN`. Enum values: `LEAD_GEN` (Instant Form), `STORE_FRONT` (Storefront Page), `APP_PROFILE_PAGE` (App Profile Page), `TIKTOK_INSTANT_PAGE` (Custom Page or Custom TikTok Instant Page), `SHOP_ADS_PLP` (Shop Ads Product List Page), `SHOP_ADS_PDP` (Shop Ads Product Detail Page), `POP_UP_FORM` (Direct Message Page). If `business_types` is also passed, `business_type` is ignored.

business_types

Filter by multiple page types. Enum values: `LEAD_GEN` (Instant Form), `STORE_FRONT` (Storefront Page), `APP_PROFILE_PAGE` (App Profile Page), `TIKTOK_INSTANT_PAGE` (Custom Page or Custom TikTok Instant Page), `SHOP_ADS_PLP` (Shop Ads Product List Page), `SHOP_ADS_PDP` (Shop Ads Product Detail Page), `POP_UP_FORM` (Direct Message Page). If passed together with `business_type`, `business_type` is ignored.

library_id

Either `advertiser_id` or `library_id` has to be set. To get pages under a Business Center, specify the ID of the form library that contains the page and leads. Pages and leads can be migrated from an ad account to a Business Center.

page

Page number for pagination. Default value: `1`. Value range: `>= 1`.

page_size

Number of results per page. Default value: `10`. Value range: `1-100`.

status

Filter by page status. Enum values: `EDITED` (draft), `PUBLISHED` (ready).

title

Page name filter. Supports exact matches only.

update_time_range

Filter pages by update time range. When `update_time_range` is passed, both `start` and `end` must be provided.