Jetti

GET /referrals/{id}.json

GET /referrals/{id}.json
Bearer auth

Path parameters

  • id integer(int64) Required

    Numeric ID of the instance

    Minimum value is 1.

Responses

  • 200 application/json

    Successful response

    Hide response attributes Show response attributes object
    • about string | null

      About

    • addressLineOne string | null

      Address line one

    • addressLineTwo string | null

      Address line two

    • authenticationSecret string | null

      Authentication secret

    • authenticationToken string | null

      Authentication token

    • city string | null

      City

    • commissionRate number | null

      Commission rate

    • country string | null

      Country

    • createdAt string(date-time)

      Created at

    • email string Required

      Email

    • id integer(int32)

      Id

    • iso string Required

      Iso

    • name string Required

      Name

    • orderEndpointUrl string | null

      Order endpoint url

    • phone string | null

      Phone

    • platform string Required

      Platform

      Values are wooCommerce or shopify.

    • referralCode string Required

      Referral code

    • returnsPolicy string | null

      Returns policy

    • shopifyStoreId integer(int32) | null

      Shopify store

    • sourceType string | null

      Source type

      Values are channel or custom.

    • state string | null

      State

    • stripeId string | null

      Stripe

    • updatedAt string(date-time)

      Updated at

    • welcomeMessage string | null

      Welcome message

    • wooCommerceStoreId integer(int32) | null

      Woo commerce store

    • zip string | null

      Zip
GET /referrals/{id}.json 
curl \
 --request GET 'http://api.example.com/v1/referrals/{id}.json' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "about": "string",
  "addressLineOne": "string",
  "addressLineTwo": "string",
  "authenticationSecret": "string",
  "authenticationToken": "string",
  "city": "string",
  "commissionRate": 42.0,
  "country": "string",
  "createdAt": "2025-05-04T09:42:00Z",
  "email": "string",
  "id": 42,
  "iso": "string",
  "logo": "string",
  "name": "string",
  "orderEndpointUrl": "string",
  "phone": "string",
  "platform": "wooCommerce",
  "referralCode": "string",
  "returnsPolicy": "string",
  "shopifyStoreId": 42,
  "sourceType": "channel",
  "state": "string",
  "stripeId": "string",
  "updatedAt": "2025-05-04T09:42:00Z",
  "welcomeMessage": "string",
  "wooCommerceStoreId": 42,
  "zip": "string"
}