Creators

Get Creator

Changed on
get/v1/creators/{creator_id}

Request

  • Base URL
    https://api.aghanim.com/s2s
  • URL
    https://api.aghanim.com/s2s/v1/creators/{creator_id}
  • Auth
    HTTP bearer

Path parameters

creator_idstring required

Response

Successful Response

namestring required
emailstring required
avatar_urlstring
extra_terms_urlstring
extra_terms_textstring
idstring required
coupon_countinteger
revenueinteger
balanceinteger
creator_tier_group_idstring

Identifier of the tier group the creator is assigned to, if any.

current_creator_tier_idstring

Identifier of the tier the creator currently qualifies for based on lifetime gross revenue.

revenue_share_override_enabledboolean

When true, revenue_share_override_bps takes precedence over the tier's revenue_share_bps.

revenue_share_override_bpsinteger

Per-creator revenue share override in basis points (0-10000).

lifetime_gross_usd_centsinteger

Cumulative gross revenue attributed to the creator, in USD cents.

payout_fee_creator_share_bpsinteger

Share of the payment provider's fee this creator carries, in basis points. Takes precedence over the project-wide setting; null falls back to it.

Changes

  • 0ef278347679Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • fb9750c99d0aRevision changes
    • warning

      for the path request parameter creator_id, the maxLength was set to 32