Superfiliate

Search for customers

Bearer authcustomers.read
GETapi.superfiliate.com/api/v1/customers

Query parameters7

id
string
—
email
string
—
enrolled
boolean
—
enrolled_start_date
string
—
enrolled_end_date
string
—
page
integer
Default is 1default:1
items
integer
Default is 25 and maximum is 250default:25

Responses

A list of customers

array of objects — item fields

  • idinteger
  • emailstring

    Email address for this person.

  • phonestring | null

    Phone number for this person.

  • first_namestring | null

    Person's given name.

  • last_namestring | null

    Person's family name.

  • instagram_handlestring | null

    The instagram handle for this resource.

  • tiktok_handlestring | null

    The tiktok handle for this resource.

  • balancestring

    Store credit amount in wallet. Eg. "12.3", meaning $12.30

  • codestring | null

    May be blank if customer is not enrolled yet. Public, to share with friends/followers

  • microsite_urlstring | null

    May be blank if customer is not enrolled yet. Public, to share with friends/followers

  • reward_codestring | null

    May be blank if customer is not enrolled yet. Private, to redeem their wallet balance.

  • redeem_urlstring | null

    May be blank if customer is not enrolled yet. Private, to redeem their wallet balance.

  • campaign_idinteger | null

    May be blank if customer is not enrolled yet.

  • enrolled_atstring | null

    ISO8601 timestamp when customer was enrolled. May be blank if customer is not enrolled yet.

  • tagsarray of strings

    Customer tags added via the admin app