Spark Codes

List collected spark codes

Changed on

Every spark code collected for the shop, newest first.

This is not /gmv-max/spark-codes. That endpoint returns the queue of codes waiting to be pushed to TikTok, which is empty until /gmv-max/spark-codes/sync-all is run. This one returns the codes themselves, including the ones creators submit through the spark-code form an automation DMs them.

source says where a code came from: form (submitted through the form, or entered by hand), scraped (found on the creator's video), or bulk_upload (a retainer CSV). form_uuid ties a row back to the form link the creator was sent.

permission reflects the checkbox on the form and is not a usage-rights grant — usage rights are a separate flow with their own statuses, exposed under /usage-rights.

Creator contact details captured by the same form (email, address, phone) are deliberately not returned here.

Single shop only — set x-shop-id to one shop ID.

get/spark-codes

Request

  • Base URL
    https://api.reacherapp.com/public/v1
  • URL
    https://api.reacherapp.com/public/v1/spark-codes
  • Auth
    API key in header x-api-key and API key in header x-shop-id

Query parameters

automation_idinteger nullable

Only codes collected by this automation.

creator_idstring nullable

Only codes from this TikTok creator ID.

sourcestring nullable

Restrict to one source: form, scraped, or bulk_upload. Omit for all three.

start_datestring date nullable

Only codes collected on or after this date (YYYY-MM-DD).

end_datestring date nullable

Only codes collected on or before this date (YYYY-MM-DD).

pageinteger
page_sizeinteger

Response

Successful Response

Changes