Partners
Get partner
Retrieve an existing partner by id.
GET
/
v3
/
partners
/
{id}
Get partner
curl --request GET \
--url https://api.example.com/v3/partners/{id}import requests
url = "https://api.example.com/v3/partners/{id}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/v3/partners/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v3/partners/{id}",
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/partners/{id}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/v3/partners/{id}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v3/partners/{id}")
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": 123,
"name": "<string>",
"groupId": 123,
"onboardingStatus": "Unknown",
"status": "Unknown",
"source": "Unknown",
"company": {
"id": 123,
"name": "<string>",
"websiteUrls": [
"<string>"
]
},
"mainContact": {
"id": 123,
"email": "<string>",
"firstname": "<string>",
"lastname": "<string>",
"jobTitle": "<string>",
"phoneNumber": "<string>",
"linkedInProfileUrl": "<string>",
"creationDate": "2023-11-07T05:31:56Z",
"isMainContact": true
},
"onboardingStage": {
"id": 123,
"name": "<string>",
"description": "<string>",
"order": 123,
"onboardingPipelineId": 123,
"onboardingPipelineName": "<string>"
},
"onboardingStages": [
{
"id": 123,
"name": "<string>",
"description": "<string>",
"order": 123,
"onboardingPipelineId": 123,
"onboardingPipelineName": "<string>"
}
],
"levels": [
{
"programLevelId": 123,
"programLevelName": "<string>",
"programId": 123,
"programName": "<string>"
}
],
"sinceDate": "2023-11-07T05:31:56Z",
"partnerTypeId": 123,
"partnerTypeName": "<string>",
"properties": {},
"ownerUserId": 123,
"owner": {
"id": 123,
"email": "<string>",
"firstName": "<string>",
"lastName": "<string>"
},
"referralCode": "<string>",
"paypalEmail": "<string>",
"currency": "<string>",
"payoutProvider": {
"type": "Unknown",
"details": {}
},
"language": "<string>"
}Path Parameters
The ID of the partner to return.
Response
Partner found
Available options:
Unknown, NotOnboarded, InProgress, Completed Available options:
Unknown, Active, Prospect, Rejected, Applicant, Inactive, Onboarding Available options:
Unknown, ManuallyAdded, SignupForm Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Get partner
curl --request GET \
--url https://api.example.com/v3/partners/{id}import requests
url = "https://api.example.com/v3/partners/{id}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/v3/partners/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v3/partners/{id}",
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/partners/{id}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/v3/partners/{id}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v3/partners/{id}")
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": 123,
"name": "<string>",
"groupId": 123,
"onboardingStatus": "Unknown",
"status": "Unknown",
"source": "Unknown",
"company": {
"id": 123,
"name": "<string>",
"websiteUrls": [
"<string>"
]
},
"mainContact": {
"id": 123,
"email": "<string>",
"firstname": "<string>",
"lastname": "<string>",
"jobTitle": "<string>",
"phoneNumber": "<string>",
"linkedInProfileUrl": "<string>",
"creationDate": "2023-11-07T05:31:56Z",
"isMainContact": true
},
"onboardingStage": {
"id": 123,
"name": "<string>",
"description": "<string>",
"order": 123,
"onboardingPipelineId": 123,
"onboardingPipelineName": "<string>"
},
"onboardingStages": [
{
"id": 123,
"name": "<string>",
"description": "<string>",
"order": 123,
"onboardingPipelineId": 123,
"onboardingPipelineName": "<string>"
}
],
"levels": [
{
"programLevelId": 123,
"programLevelName": "<string>",
"programId": 123,
"programName": "<string>"
}
],
"sinceDate": "2023-11-07T05:31:56Z",
"partnerTypeId": 123,
"partnerTypeName": "<string>",
"properties": {},
"ownerUserId": 123,
"owner": {
"id": 123,
"email": "<string>",
"firstName": "<string>",
"lastName": "<string>"
},
"referralCode": "<string>",
"paypalEmail": "<string>",
"currency": "<string>",
"payoutProvider": {
"type": "Unknown",
"details": {}
},
"language": "<string>"
}