GET /referrals/{id}.json

GET /referrals/{id}.json

Path parameters

  • id integer(int64) Required

    Numeric ID of the instance

    Minimum value is 1.

Responses

GET /referrals/{id}.json
curl \
 -X GET http://api.example.com/v1/referrals/{id}.json \
 -H "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": "2024-05-04T09:42:00+00:00",
  "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": "2024-05-04T09:42:00+00:00",
  "welcomeMessage": "string",
  "wooCommerceStoreId": 42,
  "zip": "string"
}