List partner properties - Kiflo

GET

/

v3

/

rewards

/

properties

List partner properties

curl --request GET \
  --url https://api.example.com/v3/rewards/properties

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v3/rewards/properties",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v3/rewards/properties"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v3/rewards/properties")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

[
  {
    "id": 1,
    "entityType": "Transaction",
    "propertyType": "SingleLineText",
    "name": "name",
    "label": "Name",
    "placeholder": null,
    "description": "The name",
    "isRequired": false,
    "isVisible": false,
    "isPartnerEditable": false,
    "isCustom": false,
    "isReadOnly": false,
    "displayOrder": 0,
    "isDealAmountPart": false,
    "canEditDescription": false,
    "canEditIsRequired": false,
    "dropdownConfiguration": null
  }
]

Response

200 - application/json

Success

id

integer<int32>

entityType

enum<string>

Available options:

Unknown,

Deal,

Contact,

Lead,

Partner,

Transaction,

Customer,

RewardDefinition,

Product,

LineItem,

Payout,

BusinessPlan,

PartnerApplication,

Asset,

Event,

Task,

View,

TeamMember,

TeamMemberCertification,

Certification,

OnboardingPipeline,

OnboardingStage,

Article,

OnboardingStageAction,

Comment,

Note,

Workflow,

WorkflowEnrollment,

Group,

PartnerProgram,

ProgramLevel,

OnboardingStageActionResult,

Attachment,

Meeting,

Reward,

WorkflowTemplate,

IntegrationFieldMapping,

ProspectionPipeline,

EmailTemplate,

ProspectPartner,

News,

Collection,

IntegrationLog,

PartnerDirectory,

DirectoryProfile,

DirectoryProfilePartnerPreview,

HubSpotFormMapping,

AccountMappingDataSource,

Account,

OverlappingPartnerAccount,

OverlappingTenantAccount,

Collaboration,

ProductPrice,

AccessToken,

AccountOverlap

propertyType

enum<string>

Available options:

Unknown,

SingleLineText,

MultiLineText,

Number,

Currency,

Url,

Email,

SingleSelect,

Percent,

Reward,

Date,

Checkbox,

MultiSelect,

Object,

Enum,

User

name

string | null

label

string | null

placeholder

string | null

description

string | null

isRequired

boolean

isVisible

boolean

isPartnerEditable

boolean

isCustom

boolean

isReadOnly

boolean

displayOrder

integer<int32>

isDealAmountPart

boolean

canEditDescription

boolean

canEditIsRequired

boolean

Show child attributes

List partner properties

curl --request GET \
  --url https://api.example.com/v3/rewards/properties

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v3/rewards/properties",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v3/rewards/properties"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v3/rewards/properties")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

[
  {
    "id": 1,
    "entityType": "Transaction",
    "propertyType": "SingleLineText",
    "name": "name",
    "label": "Name",
    "placeholder": null,
    "description": "The name",
    "isRequired": false,
    "isVisible": false,
    "isPartnerEditable": false,
    "isCustom": false,
    "isReadOnly": false,
    "displayOrder": 0,
    "isDealAmountPart": false,
    "canEditDescription": false,
    "canEditIsRequired": false,
    "dropdownConfiguration": null
  }
]