Skip to main content
GET
Preview a creator removal

Authorizations

x-api-key
string
header
required

API key created in Dashboard → Settings → Developer

Path Parameters

id
string<uuid>
required

The program id

creatorId
string
required

The creator id from GET /creators

Query Parameters

scope
enum<string>
default:company

Choose the data scope. company (default) limits results to the API key company's data. agency includes the parent agency and its linked brands. scope=agency requires a parent agency key; other keys receive 403.

Available options:
company,
agency

Response

What the removal would do

programId
string<uuid>
programName
string
creatorId
string
creatorName
string
handles
object[]

The creator's accounts on the program

sameNameCreators
object[]

Up to 5 other approved creators on the program with the same name. Names are the same when they match without spaces and letter case.

canRemovePayments
boolean

true: paymentAction can be keep or remove. false: only keep is allowed.

paymentsKeptReason
string | null

Why only keep is allowed, as the dashboard shows it. null when remove is allowed.