Get Application Customer Friends

List friends referred by customer profile

GET/v1/applications/{applicationId}/profile/{integrationId}/friends

Use it in a workflow

Add a step and choose the Talon.One connector.
Pick the Get Application Customer Friends action (under management).
Fill in the fields below, then reference the result from later steps as {{getApplicationCustomerFriends.response.data}}.

Request

Path parameters

applicationIdinteger (int64)required

The ID of the Application. It is displayed in your Talon.One deployment URL.

integrationIdstringrequired

The Integration ID of the Advocate's Profile.

Query parameters

pageSizeinteger (int64)

The number of items in the response.

Default 1000

skipinteger (int64)

The number of items to skip when paging through large result sets.

sortstring

The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.

withTotalResultSizeboolean

When this flag is set, the result includes the total number of results for this query. This might decrease performance on large data sets. - When `true`: `totalResultSize` contains the total number of results for this query. - When `false`: Only `hasMore` is returned, and it is set to `true` when there are more results than shown on the page.

Response

Returns 200 with an object. Read it in later steps with {{getApplicationCustomerFriends.response.data.<field>}}.

hasMoreboolean

totalResultSizeinteger (int64)

dataarray<object>

applicationIdinteger (int64)required

The ID of the Application that owns this entity.

sessionIdstringrequired

Integration ID of the session in which the customer redeemed the referral.

advocateIntegrationIdstringrequired

Integration ID of the Advocate's Profile.

friendIntegrationIdstringrequired

Integration ID of the Friend's Profile.

codestringrequired

Advocate's referral code.

createdstring (date-time)required

Timestamp of the moment the customer redeemed the referral.

json

{
  "data": [
    {
      "friendIntegrationId": "friendIntegrationId",
      "code": "code",
      "created": {},
      "sessionId": "sessionId",
      "advocateIntegrationId": "advocateIntegrationId",
      "applicationId": 322
    }
  ],
  "hasMore": false,
  "totalResultSize": 1
}

Need more? See the Talon.One guide for connection setup and behaviour shared by every action.

Was this page helpful?