List certifications given to partner contacts. - Kiflo

GET

/

v3

/

partner-contact-certifications

List certifications given to partner contacts.

curl --request GET \
  --url https://api.example.com/v3/partner-contact-certifications

const options = {method: 'GET'};

fetch('https://api.example.com/v3/partner-contact-certifications', 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/partner-contact-certifications",
  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/partner-contact-certifications"

	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/partner-contact-certifications")

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

{
  "items": [
    {
      "id": 123,
      "creationDate": "2023-11-07T05:31:56Z",
      "acquisitionDate": "2023-11-07T05:31:56Z",
      "expirationDate": "2023-11-07T05:31:56Z",
      "status": "Unknown",
      "partnerContactId": 123,
      "certificationId": 123
    }
  ],
  "paginationSkipCount": 123,
  "totalCount": 123
}

Query Parameters

partner_id

integer<int32>

The specific partner for which certifications must be returned.

partner_contact_id

integer<int32>

The specific partner contact (team members) for which certifications must be returned.

certification_id

integer<int32>

The specific certification for which all partner contacts must be returned.

status

enum<string>[]

Only returned certifications given to partner contacts with the specific status.

Available options:

Unknown,

InProgress,

Active,

Expired,

Renewed

offset

integer<int32>

The cursor used in pagination. This is the index of the first partner contact to be returned.

limit

integer<int32>

The maximum number of partner contacts to be returned. The default is 20.

sort_by

string

The property used to sort the partner contacts by. The default is CreationDate.

Example:

"CreationDate"

order_by

string

The sorting direction for the returned partner contacts. Accepted values: ASC, DESC. The default is DESC.

email

string

The exact email address of the partner contact for which certifications must be returned.

Response

200 - application/json

Partner certifications returned

items

object[] | null

Show child attributes

paginationSkipCount

integer<int32>

totalCount

integer<int32>

List certifications given to partner contacts.

curl --request GET \
  --url https://api.example.com/v3/partner-contact-certifications

const options = {method: 'GET'};

fetch('https://api.example.com/v3/partner-contact-certifications', 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/partner-contact-certifications",
  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/partner-contact-certifications"

	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/partner-contact-certifications")

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

{
  "items": [
    {
      "id": 123,
      "creationDate": "2023-11-07T05:31:56Z",
      "acquisitionDate": "2023-11-07T05:31:56Z",
      "expirationDate": "2023-11-07T05:31:56Z",
      "status": "Unknown",
      "partnerContactId": 123,
      "certificationId": 123
    }
  ],
  "paginationSkipCount": 123,
  "totalCount": 123
}