Creators · Docs

An account sees the creators it works with: creators in its programs and, for a partner, the creators on its roster.

List creators

GET /v1/creators filters by q (a name, email or handle), status, program, relationship and visibility:

TypeScript

const { data: page } = await lucra.creators.list({
  query: { program: "prog_00lhuAJjQgdtNt5WnqTBc95", q: "sam" },
})

Add a creator to your roster

A partner adds a creator by email with POST /v1/creators:

TypeScript

const { data: creator } = await lucra.creators.create({
  body: { email: "sam@example.com", name: "Sam Rivera", visibility: "private" },
})

What happens next depends on the creator:

New to Lucra: they get an account to claim later, and you can act for them right away with Lucra-Account: crtr_….
Already on Lucra, or left your roster before: they're emailed an invite and show as invited. You can act for them once they accept.
Already on your roster: you get them back with 200.

A creator can be on one partner's roster at a time.

Manage the roster

Choose which client brands a roster creator works with by sending the full list. A brand left out stops working with them:

TypeScript

await lucra.creators.update({
  path: { id: "crtr_026UYfiw1Y6OvUpuKWiOpeL" },
  body: { brands: ["acct_07RodMW6bE7BBO6e1I3UzSi"] },
})

Send { "status": "removed" } to take a creator off the roster, or takeRate to set your cut of their pay.

Edit a creator's profile

Acting as the creator (Lucra-Account: crtr_…), PATCH /v1/creators/:id with their own ID edits their name, bio, interests and location.

Location: search the city catalog with GET /v1/cities?q=…, then send the picked city as locationDetails, with its displayName as location.
Photo: send profilePicture, a profile_picture file uploaded as the creator. Or send pictureFrom: "instagram" or "tiktok" to use a connected account's photo.

Visibility

private hides a creator from brands browsing Explore; network lets any brand find them. Either way, they can apply to programs open to the network.

A creator is paid to their own Stripe balance once payouts.identity.status is verified. Until then they keep earning. To finish setup, send them to the URL from POST /v1/connections with provider: "stripe". The creator.payouts_updated webhook tells you when their setup changes.

Endpoints

GET/v1/creators

read

List the account's creators and, for a partner, its roster

const { data } = await lucra.creators.list({
  query: { q: "…" },
})

Query parameters

qstring
Matches the name, email or a handle.
statusstring
One or more of invited, live, paused, review, removed; removed creators are left out unless asked for.
programprog_…
Only creators approved into this program.
relationshipenum
directrepresented
visibilityenum
privatenetwork

Plus paging: limit, cursor, createdAfter and createdBefore.

Response200A page of items, 32 fields each, and nextCursorShow

idcrtr_…
namestring
handlestringnullable
emailstringnullable
phonestringnullable
profilePicturefile_…nullable
imageobjectnullable
The creator's picture, with a short-lived url.
Show 5 child fieldsHide child fields
- fileIdfile_…nullable
- urlstring
- widthnumbernullable
- heightnumbernullable
- blurHashstringnullable
biostringnullable
locationstringnullable
platformHandlesobject
Handles by platform, e.g. { tiktok: "@sam" }.
tagsstring[]
notesstringnullable
statusenumnullable
The creator's status with this account; null on a marketplace listing of a creator not in it.
invitedlivepausedreviewremoved
relationshipenumnullable
direct: in this account; represented: on a partner's roster; null on a marketplace listing of a creator not in it.
directrepresented
managedByacct_…nullable
visibilityenum
private: hidden from brands' discovery; network: brands can find them.
privatenetwork
chatAvailableboolean
programsprog_…[]
Programs the creator is approved into in this account.
brandsacct_…[]
A partner's roster creator: the client brands they work with through the partner.
retainerobjectnullable
The creator's open retainer with this account and its terms; GET /v1/retainers/:id has the rest.
Show 8 child fieldsHide child fields
- idret_…
- statusenum
  offeredacceptedactivecanceling
- payobject
  Show 5 child fieldsHide child fields
  rulesobject[]
  baseinteger
  Guaranteed each period, in cents.
  capintegernullable
  The most one creator is paid per period, in cents; null or left out for no cap.
  scheduleobject
  approvalenum
  automatic pays each period on its own; manual waits for the brand to approve the calculated amount.
  automaticmanual
- summarystring
  The pay in plain English.
- currencystring
  Lowercase ISO 4217 code, e.g. usd.
- deliverablesstringnullable
- notesstringnullable
- currentPeriodEndAtstringnullable
payoutsobjectnullable
Where the creator is paid. To finish setup, send the creator to the URL from POST /v1/connections with provider: "stripe"; creator.payouts_updated fires when it changes. Null on a marketplace listing.
Show 2 child fieldsHide child fields
- identityobject
  Show 1 child fieldHide child fields
  statusenum
  requiredpendingverified
- bankAccountobjectnullable
  Show 1 child fieldHide child fields
  statusenum
  missingadded
statsobject
Show 4 child fieldsHide child fields
- approvedVideosinteger
- pendingVideosinteger
- approvalRatenumber
  Percent of reviewed submissions approved.
- installsinteger
tierenum
The tier the creator's XP reaches, Bronze to Diamond.
bronzesilvergoldplatinumdiamond
performanceobjectnullable
Daily ad results of the creator's work and submissions approved each day, for this account; null outside its own creators.
Show 2 child fieldsHide child fields
- currencystring
  Lowercase ISO 4217 code, e.g. usd.
- daysobject[]
  Show 7 child fieldsHide child fields
  datestring
  spendinteger
  revenueinteger
  clicksinteger
  impressionsinteger
  purchasesinteger
  approvedSubmissionsinteger
referenceVideosobject[]
Posts the creator shows brands, newest choice first.
Show 10 child fieldsHide child fields
- platformenum
  instagramtiktokupload
- poststring
  The post's ID on its platform; for an upload, the uploaded video's file_….
- filefile_…nullable
- urlstringnullable
- titlestringnullable
- publishedAtstringnullable
- durationLabelstringnullable
- thumbnailUrlstringnullable
- thumbnailImageobjectnullable
  Show 5 child fieldsHide child fields
  fileIdfile_…nullable
  urlstring
  widthnumbernullable
  heightnumbernullable
  blurHashstringnullable
- videoUrlstringnullable
takeRateobjectnullable
A partner's roster creator: the partner's cut of their pay. Null elsewhere.
Show 2 child fieldsHide child fields
- percentnumber
- customboolean
  Set for this creator alone; false follows the partner's default.
claimobjectnullable
A partner's roster creator: whether they've claimed the account Lucra made for them. They claim it by signing in to Lucra with that email, verified.
Show 1 child fieldHide child fields
- statusenum
  invitedclaimed
listingobject
A marketplace listing's fields; only on GET /v1/marketplace/creators.
Show 12 child fieldsHide child fields
- headlinestringnullable
- specialtystringnullable
- agenumbernullable
- genderstringnullable
- categoriesstring[]
- creativeStylesstring[]
- interestsstring[]
- requestStatusenumnullable
  Your account's latest connection request to them.
  pendingaccepteddeclined
- audiencestringnullable
- lastActivestringnullable
- responseTimestringnullable
- submissionsobject[]
  Work the creator submitted on Lucra; on one creator's read.
  Show 10 child fieldsHide child fields
  idsub_…
  programNamestringnullable
  platformenumnullable
  instagramtiktok
  statusenum
  approvedliverejectedreviewrevision
  submittedAtstringnullable
  durationstringnullable
  formatstringnullable
  thumbnailUrlstringnullable
  videoUrlstringnullable
  thumbnailImageobjectnullable
  Show 5 child fieldsHide child fields
  fileIdfile_…nullable
  urlstring
  widthnumbernullable
  heightnumbernullable
  blurHashstringnullable
profileobject
Only when a creator reads themselves.
Show 8 child fieldsHide child fields
- birthDatestringnullable
- genderstringnullable
- interestsstring[]
- creativeStylesstring[]
- locationDetailsobjectnullable
  Show 9 child fieldsHide child fields
  citystring
  countryCodestring
  countryNamestring
  displayNamestring
  geonamesIdstring
  latitudenumber
  longitudenumber
  regionCodestring
  regionNamestring
- onboardingCompletedAtstringnullable
- hiddenFromacct_…[]
  Partners that hide this creator from their Discover.
- partnerFeeobjectnullable
  The share of the creator's pay the partner representing them (managedBy) takes, if any.
  Show 2 child fieldsHide child fields
  partneracct_…
  percentnumber
versioninteger
Send it back on PATCH to reject edits based on a stale read.
createdAtstring
updatedAtstring

GET/v1/creators/:id

As creatorread

Get one of the account's creators, or, as a creator, yourself

const { data } = await lucra.creators.retrieve({
  path: { id: "crtr_…" },
})

Path parameters

idcrtr_…· required

Response20032 fieldsShow

idcrtr_…
namestring
handlestringnullable
emailstringnullable
phonestringnullable
profilePicturefile_…nullable
imageobjectnullable
The creator's picture, with a short-lived url.
Show 5 child fieldsHide child fields
- fileIdfile_…nullable
- urlstring
- widthnumbernullable
- heightnumbernullable
- blurHashstringnullable
biostringnullable
locationstringnullable
platformHandlesobject
Handles by platform, e.g. { tiktok: "@sam" }.
tagsstring[]
notesstringnullable
statusenumnullable
The creator's status with this account; null on a marketplace listing of a creator not in it.
invitedlivepausedreviewremoved
relationshipenumnullable
direct: in this account; represented: on a partner's roster; null on a marketplace listing of a creator not in it.
directrepresented
managedByacct_…nullable
visibilityenum
private: hidden from brands' discovery; network: brands can find them.
privatenetwork
chatAvailableboolean
programsprog_…[]
Programs the creator is approved into in this account.
brandsacct_…[]
A partner's roster creator: the client brands they work with through the partner.
retainerobjectnullable
The creator's open retainer with this account and its terms; GET /v1/retainers/:id has the rest.
Show 8 child fieldsHide child fields
- idret_…
- statusenum
  offeredacceptedactivecanceling
- payobject
  Show 5 child fieldsHide child fields
  rulesobject[]
  baseinteger
  Guaranteed each period, in cents.
  capintegernullable
  The most one creator is paid per period, in cents; null or left out for no cap.
  scheduleobject
  approvalenum
  automatic pays each period on its own; manual waits for the brand to approve the calculated amount.
  automaticmanual
- summarystring
  The pay in plain English.
- currencystring
  Lowercase ISO 4217 code, e.g. usd.
- deliverablesstringnullable
- notesstringnullable
- currentPeriodEndAtstringnullable
payoutsobjectnullable
Where the creator is paid. To finish setup, send the creator to the URL from POST /v1/connections with provider: "stripe"; creator.payouts_updated fires when it changes. Null on a marketplace listing.
Show 2 child fieldsHide child fields
- identityobject
  Show 1 child fieldHide child fields
  statusenum
  requiredpendingverified
- bankAccountobjectnullable
  Show 1 child fieldHide child fields
  statusenum
  missingadded
statsobject
Show 4 child fieldsHide child fields
- approvedVideosinteger
- pendingVideosinteger
- approvalRatenumber
  Percent of reviewed submissions approved.
- installsinteger
tierenum
The tier the creator's XP reaches, Bronze to Diamond.
bronzesilvergoldplatinumdiamond
performanceobjectnullable
Daily ad results of the creator's work and submissions approved each day, for this account; null outside its own creators.
Show 2 child fieldsHide child fields
- currencystring
  Lowercase ISO 4217 code, e.g. usd.
- daysobject[]
  Show 7 child fieldsHide child fields
  datestring
  spendinteger
  revenueinteger
  clicksinteger
  impressionsinteger
  purchasesinteger
  approvedSubmissionsinteger
referenceVideosobject[]
Posts the creator shows brands, newest choice first.
Show 10 child fieldsHide child fields
- platformenum
  instagramtiktokupload
- poststring
  The post's ID on its platform; for an upload, the uploaded video's file_….
- filefile_…nullable
- urlstringnullable
- titlestringnullable
- publishedAtstringnullable
- durationLabelstringnullable
- thumbnailUrlstringnullable
- thumbnailImageobjectnullable
  Show 5 child fieldsHide child fields
  fileIdfile_…nullable
  urlstring
  widthnumbernullable
  heightnumbernullable
  blurHashstringnullable
- videoUrlstringnullable
takeRateobjectnullable
A partner's roster creator: the partner's cut of their pay. Null elsewhere.
Show 2 child fieldsHide child fields
- percentnumber
- customboolean
  Set for this creator alone; false follows the partner's default.
claimobjectnullable
A partner's roster creator: whether they've claimed the account Lucra made for them. They claim it by signing in to Lucra with that email, verified.
Show 1 child fieldHide child fields
- statusenum
  invitedclaimed
listingobject
A marketplace listing's fields; only on GET /v1/marketplace/creators.
Show 12 child fieldsHide child fields
- headlinestringnullable
- specialtystringnullable
- agenumbernullable
- genderstringnullable
- categoriesstring[]
- creativeStylesstring[]
- interestsstring[]
- requestStatusenumnullable
  Your account's latest connection request to them.
  pendingaccepteddeclined
- audiencestringnullable
- lastActivestringnullable
- responseTimestringnullable
- submissionsobject[]
  Work the creator submitted on Lucra; on one creator's read.
  Show 10 child fieldsHide child fields
  idsub_…
  programNamestringnullable
  platformenumnullable
  instagramtiktok
  statusenum
  approvedliverejectedreviewrevision
  submittedAtstringnullable
  durationstringnullable
  formatstringnullable
  thumbnailUrlstringnullable
  videoUrlstringnullable
  thumbnailImageobjectnullable
  Show 5 child fieldsHide child fields
  fileIdfile_…nullable
  urlstring
  widthnumbernullable
  heightnumbernullable
  blurHashstringnullable
profileobject
Only when a creator reads themselves.
Show 8 child fieldsHide child fields
- birthDatestringnullable
- genderstringnullable
- interestsstring[]
- creativeStylesstring[]
- locationDetailsobjectnullable
  Show 9 child fieldsHide child fields
  citystring
  countryCodestring
  countryNamestring
  displayNamestring
  geonamesIdstring
  latitudenumber
  longitudenumber
  regionCodestring
  regionNamestring
- onboardingCompletedAtstringnullable
- hiddenFromacct_…[]
  Partners that hide this creator from their Discover.
- partnerFeeobjectnullable
  The share of the creator's pay the partner representing them (managedBy) takes, if any.
  Show 2 child fieldsHide child fields
  partneracct_…
  percentnumber
versioninteger
Send it back on PATCH to reject edits based on a stale read.
createdAtstring
updatedAtstring

POST/v1/creators

write

Add a creator to a partner's roster; one already on it is returned with 200, and one with a Lucra account is invited (status invited) until they accept

const { data } = await lucra.creators.create({
  body: { email: "…" },
})

Body

emailstring· required
namestring
phonestring
visibilityenum
privatenetwork

Response20132 fieldsShow

idcrtr_…
namestring
handlestringnullable
emailstringnullable
phonestringnullable
profilePicturefile_…nullable
imageobjectnullable
The creator's picture, with a short-lived url.
Show 5 child fieldsHide child fields
- fileIdfile_…nullable
- urlstring
- widthnumbernullable
- heightnumbernullable
- blurHashstringnullable
biostringnullable
locationstringnullable
platformHandlesobject
Handles by platform, e.g. { tiktok: "@sam" }.
tagsstring[]
notesstringnullable
statusenumnullable
The creator's status with this account; null on a marketplace listing of a creator not in it.
invitedlivepausedreviewremoved
relationshipenumnullable
direct: in this account; represented: on a partner's roster; null on a marketplace listing of a creator not in it.
directrepresented
managedByacct_…nullable
visibilityenum
private: hidden from brands' discovery; network: brands can find them.
privatenetwork
chatAvailableboolean
programsprog_…[]
Programs the creator is approved into in this account.
brandsacct_…[]
A partner's roster creator: the client brands they work with through the partner.
retainerobjectnullable
The creator's open retainer with this account and its terms; GET /v1/retainers/:id has the rest.
Show 8 child fieldsHide child fields
- idret_…
- statusenum
  offeredacceptedactivecanceling
- payobject
  Show 5 child fieldsHide child fields
  rulesobject[]
  baseinteger
  Guaranteed each period, in cents.
  capintegernullable
  The most one creator is paid per period, in cents; null or left out for no cap.
  scheduleobject
  approvalenum
  automatic pays each period on its own; manual waits for the brand to approve the calculated amount.
  automaticmanual
- summarystring
  The pay in plain English.
- currencystring
  Lowercase ISO 4217 code, e.g. usd.
- deliverablesstringnullable
- notesstringnullable
- currentPeriodEndAtstringnullable
payoutsobjectnullable
Where the creator is paid. To finish setup, send the creator to the URL from POST /v1/connections with provider: "stripe"; creator.payouts_updated fires when it changes. Null on a marketplace listing.
Show 2 child fieldsHide child fields
- identityobject
  Show 1 child fieldHide child fields
  statusenum
  requiredpendingverified
- bankAccountobjectnullable
  Show 1 child fieldHide child fields
  statusenum
  missingadded
statsobject
Show 4 child fieldsHide child fields
- approvedVideosinteger
- pendingVideosinteger
- approvalRatenumber
  Percent of reviewed submissions approved.
- installsinteger
tierenum
The tier the creator's XP reaches, Bronze to Diamond.
bronzesilvergoldplatinumdiamond
performanceobjectnullable
Daily ad results of the creator's work and submissions approved each day, for this account; null outside its own creators.
Show 2 child fieldsHide child fields
- currencystring
  Lowercase ISO 4217 code, e.g. usd.
- daysobject[]
  Show 7 child fieldsHide child fields
  datestring
  spendinteger
  revenueinteger
  clicksinteger
  impressionsinteger
  purchasesinteger
  approvedSubmissionsinteger
referenceVideosobject[]
Posts the creator shows brands, newest choice first.
Show 10 child fieldsHide child fields
- platformenum
  instagramtiktokupload
- poststring
  The post's ID on its platform; for an upload, the uploaded video's file_….
- filefile_…nullable
- urlstringnullable
- titlestringnullable
- publishedAtstringnullable
- durationLabelstringnullable
- thumbnailUrlstringnullable
- thumbnailImageobjectnullable
  Show 5 child fieldsHide child fields
  fileIdfile_…nullable
  urlstring
  widthnumbernullable
  heightnumbernullable
  blurHashstringnullable
- videoUrlstringnullable
takeRateobjectnullable
A partner's roster creator: the partner's cut of their pay. Null elsewhere.
Show 2 child fieldsHide child fields
- percentnumber
- customboolean
  Set for this creator alone; false follows the partner's default.
claimobjectnullable
A partner's roster creator: whether they've claimed the account Lucra made for them. They claim it by signing in to Lucra with that email, verified.
Show 1 child fieldHide child fields
- statusenum
  invitedclaimed
listingobject
A marketplace listing's fields; only on GET /v1/marketplace/creators.
Show 12 child fieldsHide child fields
- headlinestringnullable
- specialtystringnullable
- agenumbernullable
- genderstringnullable
- categoriesstring[]
- creativeStylesstring[]
- interestsstring[]
- requestStatusenumnullable
  Your account's latest connection request to them.
  pendingaccepteddeclined
- audiencestringnullable
- lastActivestringnullable
- responseTimestringnullable
- submissionsobject[]
  Work the creator submitted on Lucra; on one creator's read.
  Show 10 child fieldsHide child fields
  idsub_…
  programNamestringnullable
  platformenumnullable
  instagramtiktok
  statusenum
  approvedliverejectedreviewrevision
  submittedAtstringnullable
  durationstringnullable
  formatstringnullable
  thumbnailUrlstringnullable
  videoUrlstringnullable
  thumbnailImageobjectnullable
  Show 5 child fieldsHide child fields
  fileIdfile_…nullable
  urlstring
  widthnumbernullable
  heightnumbernullable
  blurHashstringnullable
profileobject
Only when a creator reads themselves.
Show 8 child fieldsHide child fields
- birthDatestringnullable
- genderstringnullable
- interestsstring[]
- creativeStylesstring[]
- locationDetailsobjectnullable
  Show 9 child fieldsHide child fields
  citystring
  countryCodestring
  countryNamestring
  displayNamestring
  geonamesIdstring
  latitudenumber
  longitudenumber
  regionCodestring
  regionNamestring
- onboardingCompletedAtstringnullable
- hiddenFromacct_…[]
  Partners that hide this creator from their Discover.
- partnerFeeobjectnullable
  The share of the creator's pay the partner representing them (managedBy) takes, if any.
  Show 2 child fieldsHide child fields
  partneracct_…
  percentnumber
versioninteger
Send it back on PATCH to reject edits based on a stale read.
createdAtstring
updatedAtstring

PATCH/v1/creators/:id

As creatorwrite

Update a creator: a brand's labels and status, a partner's roster creator, or, as a creator, your own profile

const { data } = await lucra.creators.update({
  path: { id: "crtr_…" },
  body: { visibility: "private" },
})

Path parameters

idcrtr_…· required

Body

visibilityenum
privatenetwork
profilePicturefile_…nullable
tagsstring[]
notesstringnullable
statusenum
livepausedremoved
brandsacct_…[]
A partner's roster creator works with exactly these client brands; brands left out stop working with them.
takeRatenumbernullable
A partner's roster creator: the partner's cut of their pay, as a percent, from now on; null puts them back on the partner's default.
biostring
birthDatestringnullable
creativeStylesenum[]
product_demotestimonial_reviewtalking_headvoiceover_brolllifestyle_routineunboxingscreen_recordingcomedy_skit
emailstring
genderenumnullable
womanmannonbinaryself_describeundisclosed
handlestring
Your @handle, unique on Lucra: 1–30 letters, numbers, periods, underscores or hyphens. A leading @ is dropped and it is saved lowercase.
interestsenum[]
fitnessbeautyfashionfood_drinktech_gamingtravelhome_diyparentingfinancewellnesspetscomedyeducationoutdoorsfitness_gymfitness_runningfitness_yogafitness_sportsbeauty_makeupbeauty_skincarebeauty_hairbeauty_nailsfashion_streetwearfashion_luxuryfashion_thriftfashion_menswearfood_drink_cookingfood_drink_bakingfood_drink_restaurantsfood_drink_coffeetech_gaming_gamingtech_gaming_gadgetstech_gaming_appstech_gaming_aitravel_budgettravel_luxurytravel_citytravel_adventurehome_diy_renovationhome_diy_decorhome_diy_gardeninghome_diy_organizationparenting_pregnancyparenting_babiesparenting_school_ageparenting_teensfinance_investingfinance_budgetingfinance_side_hustlesfinance_cryptowellness_mental_healthwellness_meditationwellness_nutritionwellness_sleeppets_dogspets_catspets_exoticpets_trainingcomedy_skitscomedy_prankscomedy_memescomedy_standupeducation_studyeducation_languageseducation_scienceeducation_historyoutdoors_campingoutdoors_hikingoutdoors_fishingoutdoors_climbing
locationstring
locationDetailsobjectnullable
Show 9 child fieldsHide child fields
- citystring· required
- countryCodestring· required
- countryNamestring· required
- displayNamestring· required
- geonamesIdstring
- latitudenumber
- longitudenumber
- regionCodestring
- regionNamestring
namestring
platformHandlesobject
Show 2 child fieldsHide child fields
- instagramstring
- tiktokstring
referenceVideoSelectionsobject[]
Show 10 child fieldsHide child fields
- durationLabelstring
- mediaAssetIdstring
- platformenum· required
  instagramtiktokupload
- publishedAtstring
- sourceContentIdstring· required
- sourceUrlstring
- thumbnailImageobjectnullable
  Show 5 child fieldsHide child fields
  fileIdstring· required
  urlstring
  widthintegernullable
  heightintegernullable
  blurHashstringnullable
- thumbnailUrlstring
- titlestring
- videoUrlstring
referenceVideosstring[]
pictureFromenum
Use this connected account's profile photo as the creator's picture.
instagramtiktok
versioninteger

Response20032 fieldsShow

idcrtr_…
namestring
handlestringnullable
emailstringnullable
phonestringnullable
profilePicturefile_…nullable
imageobjectnullable
The creator's picture, with a short-lived url.
Show 5 child fieldsHide child fields
- fileIdfile_…nullable
- urlstring
- widthnumbernullable
- heightnumbernullable
- blurHashstringnullable
biostringnullable
locationstringnullable
platformHandlesobject
Handles by platform, e.g. { tiktok: "@sam" }.
tagsstring[]
notesstringnullable
statusenumnullable
The creator's status with this account; null on a marketplace listing of a creator not in it.
invitedlivepausedreviewremoved
relationshipenumnullable
direct: in this account; represented: on a partner's roster; null on a marketplace listing of a creator not in it.
directrepresented
managedByacct_…nullable
visibilityenum
private: hidden from brands' discovery; network: brands can find them.
privatenetwork
chatAvailableboolean
programsprog_…[]
Programs the creator is approved into in this account.
brandsacct_…[]
A partner's roster creator: the client brands they work with through the partner.
retainerobjectnullable
The creator's open retainer with this account and its terms; GET /v1/retainers/:id has the rest.
Show 8 child fieldsHide child fields
- idret_…
- statusenum
  offeredacceptedactivecanceling
- payobject
  Show 5 child fieldsHide child fields
  rulesobject[]
  baseinteger
  Guaranteed each period, in cents.
  capintegernullable
  The most one creator is paid per period, in cents; null or left out for no cap.
  scheduleobject
  approvalenum
  automatic pays each period on its own; manual waits for the brand to approve the calculated amount.
  automaticmanual
- summarystring
  The pay in plain English.
- currencystring
  Lowercase ISO 4217 code, e.g. usd.
- deliverablesstringnullable
- notesstringnullable
- currentPeriodEndAtstringnullable
payoutsobjectnullable
Where the creator is paid. To finish setup, send the creator to the URL from POST /v1/connections with provider: "stripe"; creator.payouts_updated fires when it changes. Null on a marketplace listing.
Show 2 child fieldsHide child fields
- identityobject
  Show 1 child fieldHide child fields
  statusenum
  requiredpendingverified
- bankAccountobjectnullable
  Show 1 child fieldHide child fields
  statusenum
  missingadded
statsobject
Show 4 child fieldsHide child fields
- approvedVideosinteger
- pendingVideosinteger
- approvalRatenumber
  Percent of reviewed submissions approved.
- installsinteger
tierenum
The tier the creator's XP reaches, Bronze to Diamond.
bronzesilvergoldplatinumdiamond
performanceobjectnullable
Daily ad results of the creator's work and submissions approved each day, for this account; null outside its own creators.
Show 2 child fieldsHide child fields
- currencystring
  Lowercase ISO 4217 code, e.g. usd.
- daysobject[]
  Show 7 child fieldsHide child fields
  datestring
  spendinteger
  revenueinteger
  clicksinteger
  impressionsinteger
  purchasesinteger
  approvedSubmissionsinteger
referenceVideosobject[]
Posts the creator shows brands, newest choice first.
Show 10 child fieldsHide child fields
- platformenum
  instagramtiktokupload
- poststring
  The post's ID on its platform; for an upload, the uploaded video's file_….
- filefile_…nullable
- urlstringnullable
- titlestringnullable
- publishedAtstringnullable
- durationLabelstringnullable
- thumbnailUrlstringnullable
- thumbnailImageobjectnullable
  Show 5 child fieldsHide child fields
  fileIdfile_…nullable
  urlstring
  widthnumbernullable
  heightnumbernullable
  blurHashstringnullable
- videoUrlstringnullable
takeRateobjectnullable
A partner's roster creator: the partner's cut of their pay. Null elsewhere.
Show 2 child fieldsHide child fields
- percentnumber
- customboolean
  Set for this creator alone; false follows the partner's default.
claimobjectnullable
A partner's roster creator: whether they've claimed the account Lucra made for them. They claim it by signing in to Lucra with that email, verified.
Show 1 child fieldHide child fields
- statusenum
  invitedclaimed
listingobject
A marketplace listing's fields; only on GET /v1/marketplace/creators.
Show 12 child fieldsHide child fields
- headlinestringnullable
- specialtystringnullable
- agenumbernullable
- genderstringnullable
- categoriesstring[]
- creativeStylesstring[]
- interestsstring[]
- requestStatusenumnullable
  Your account's latest connection request to them.
  pendingaccepteddeclined
- audiencestringnullable
- lastActivestringnullable
- responseTimestringnullable
- submissionsobject[]
  Work the creator submitted on Lucra; on one creator's read.
  Show 10 child fieldsHide child fields
  idsub_…
  programNamestringnullable
  platformenumnullable
  instagramtiktok
  statusenum
  approvedliverejectedreviewrevision
  submittedAtstringnullable
  durationstringnullable
  formatstringnullable
  thumbnailUrlstringnullable
  videoUrlstringnullable
  thumbnailImageobjectnullable
  Show 5 child fieldsHide child fields
  fileIdfile_…nullable
  urlstring
  widthnumbernullable
  heightnumbernullable
  blurHashstringnullable
profileobject
Only when a creator reads themselves.
Show 8 child fieldsHide child fields
- birthDatestringnullable
- genderstringnullable
- interestsstring[]
- creativeStylesstring[]
- locationDetailsobjectnullable
  Show 9 child fieldsHide child fields
  citystring
  countryCodestring
  countryNamestring
  displayNamestring
  geonamesIdstring
  latitudenumber
  longitudenumber
  regionCodestring
  regionNamestring
- onboardingCompletedAtstringnullable
- hiddenFromacct_…[]
  Partners that hide this creator from their Discover.
- partnerFeeobjectnullable
  The share of the creator's pay the partner representing them (managedBy) takes, if any.
  Show 2 child fieldsHide child fields
  partneracct_…
  percentnumber
versioninteger
Send it back on PATCH to reject edits based on a stale read.
createdAtstring
updatedAtstring

GET/v1/cities

As creatorread

Search cities by name, exact matches first

const { data } = await lucra.cities.list({
  query: { q: "…" },
})

Query parameters

qstring· required
A city name, or the start of one.
countrystring
Only cities in this country (ISO 3166-1 alpha-2, e.g. US).
limitinteger
Cities per page.
cursorstring
nextCursor from the previous page, with the same q and country.

Response200A page of items, 12 fields each, and nextCursorShow

geonamesIdstring
namestring
displayNamestring
citystring
regionstringnullable
regionCodestringnullable
regionNamestringnullable
countryCodestring
countryNamestring
latitudenumber
longitudenumber
timeZonestring

List creators

Add a creator to your roster

Manage the roster

Edit a creator's profile

Visibility

Getting paid

Endpoints

Query parameters

Path parameters

Body

Path parameters

Body

Query parameters