Sign in
CRM Roster

List the CRM creator roster

The shop's My Creators table: one row per creator (the most recently updated of their creator × product records), carrying the sample / content lifecycle status, lifetime and 28-day GMV, commission, fulfillment, video and live counts, and CRM tags.

Filter with any combination of status (repeatable display labels), stage (a canonical funnel stage, which overrides status), product_id, tags (creator carries ANY) and tags_all (carries ALL), plus creator_handle for a case-insensitive handle search. Sort with sort_by / sort_dir; the default is GMV descending.

start_date/end_date window the metric columns (video_gmv, total_video_views, videos_posted) — pass both or neither. Status, tags and lifetime gmv are always as-of-now.

Set include_products=true to attach each creator's product cards (title, image, status, remaining sample stock). Per-product GMV and the videos themselves are deliberately not attached — they are the two heaviest reads in this surface; fetch them per creator from GET /crm/content.

Single-shop only. Creator contact details are never returned: no real name, shipping address, phone or email. creator_name is the public TikTok handle.

get/crm/creators

Query parameters

pageinteger

1-based page number.

1-based page number.

page_sizeinteger

Rows per page (max 100).

Rows per page (max 100).

statusstring[] nullable

Repeatable status label. One of: ['Sample Requested', 'Sample Approved', 'Ready to Ship', 'Sample Shipped', 'Content Pending', 'Completed', 'Sample Request Rejected', 'Sample Request Expired', 'Content Unfulfilled', 'Idle', 'Posted Video', 'Sold Products', 'GMV Generated', 'Showcasing Product', 'Livestreamed'].

Repeatable status label. One of: ['Sample Requested', 'Sample Approved', 'Ready to Ship', 'Sample Shipped', 'Content Pending', 'Completed', 'Sample Request Rejected', 'Sample Request Expired', 'Content Unfulfilled', 'Idle', 'Posted Video', 'Sold Products', 'GMV Generated', 'Showcasing Product', 'Livestreamed'].

stagestring nullable

Canonical funnel stage id; overrides status with that stage's label set. One of: ['sample-requests', 'sample-requested', 'approved-samples', 'sample-approved', 'content-pending', 'content-unfulfilled', 'content-posted', 'generated-gmv', 'gmv-generated'].

Canonical funnel stage id; overrides status with that stage's label set. One of: ['sample-requests', 'sample-requested', 'approved-samples', 'sample-approved', 'content-pending', 'content-unfulfilled', 'content-posted', 'generated-gmv', 'gmv-generated'].

product_idstring nullable

Restrict to one product.

Restrict to one product.

tagsstring[] nullable

Repeatable. Creators carrying ANY of these CRM tags.

Repeatable. Creators carrying ANY of these CRM tags.

tags_allstring[] nullable

Repeatable. Creators carrying ALL of these CRM tags.

Repeatable. Creators carrying ALL of these CRM tags.

creator_handlestring nullable

Case-insensitive substring search on the TikTok handle.

Case-insensitive substring search on the TikTok handle.

sort_bystring nullable

Sort column. One of: ['video_num', 'live_num', 'fulfillment_rate', 'gmv', 'video_release_date', 'creator_gmv', 'follower_num', 'video_gmv', 'total_video_views', 'videos_posted', 'avg_views', 'affiliate_gmv_28d', 'units_sold', 'commission'].

Sort column. One of: ['video_num', 'live_num', 'fulfillment_rate', 'gmv', 'video_release_date', 'creator_gmv', 'follower_num', 'video_gmv', 'total_video_views', 'videos_posted', 'avg_views', 'affiliate_gmv_28d', 'units_sold', 'commission'].

sort_dir'asc' | 'desc'

Sort direction.

Sort direction.

start_datestring date nullable

Start of the metric window. Requires end_date.

Start of the metric window. Requires end_date.

end_datestring date nullable

End of the metric window. Requires start_date.

End of the metric window. Requires start_date.

include_productsboolean

Attach each creator's product cards.

Attach each creator's product cards.

Response

Successful Response

Changes

No recorded changes to this endpoint across all 1 revision of this API.