List partner organizations

curl --request GET \
  --url https://sandboxapi.kelviq.com/api/v1/partner/organizations/ \
  --header 'X-Kelviq-Partner-Key: <api-key>'

import requests

url = "https://sandboxapi.kelviq.com/api/v1/partner/organizations/"

headers = {"X-Kelviq-Partner-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-Kelviq-Partner-Key': '<api-key>'}};

fetch('https://sandboxapi.kelviq.com/api/v1/partner/organizations/', 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://sandboxapi.kelviq.com/api/v1/partner/organizations/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Kelviq-Partner-Key: <api-key>"
  ],
]);

$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://sandboxapi.kelviq.com/api/v1/partner/organizations/"

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

	req.Header.Add("X-Kelviq-Partner-Key", "<api-key>")

	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://sandboxapi.kelviq.com/api/v1/partner/organizations/")

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

request = Net::HTTP::Get.new(url)
request["X-Kelviq-Partner-Key"] = '<api-key>'

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

{
  "results": [
    {
      "userId": 4271,
      "organizationIdentifier": "8e1d7b1a-6c4d-4e3a-9b2d-3f6e4c2b1ad0",
      "organizationSlug": "acme-corp",
      "clientKey": "ck_live_a1b2c3d4e5f6",
      "serverKey": "sk_live_9z8y7x6w5v4u",
      "partnerExternalId": "acme-corp"
    }
  ],
  "count": 1
}

GET

partner

organizations

List partner organizations

curl --request GET \
  --url https://sandboxapi.kelviq.com/api/v1/partner/organizations/ \
  --header 'X-Kelviq-Partner-Key: <api-key>'

import requests

url = "https://sandboxapi.kelviq.com/api/v1/partner/organizations/"

headers = {"X-Kelviq-Partner-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-Kelviq-Partner-Key': '<api-key>'}};

fetch('https://sandboxapi.kelviq.com/api/v1/partner/organizations/', 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://sandboxapi.kelviq.com/api/v1/partner/organizations/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Kelviq-Partner-Key: <api-key>"
  ],
]);

$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://sandboxapi.kelviq.com/api/v1/partner/organizations/"

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

	req.Header.Add("X-Kelviq-Partner-Key", "<api-key>")

	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://sandboxapi.kelviq.com/api/v1/partner/organizations/")

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

request = Net::HTTP::Get.new(url)
request["X-Kelviq-Partner-Key"] = '<api-key>'

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

{
  "results": [
    {
      "userId": 4271,
      "organizationIdentifier": "8e1d7b1a-6c4d-4e3a-9b2d-3f6e4c2b1ad0",
      "organizationSlug": "acme-corp",
      "clientKey": "ck_live_a1b2c3d4e5f6",
      "serverKey": "sk_live_9z8y7x6w5v4u",
      "partnerExternalId": "acme-corp"
    }
  ],
  "count": 1
}

Authorizations

X-Kelviq-Partner-Key

string

header

required

Partner integration secret issued by kelviq. Send the raw secret (prefixed kvqp_) in the X-Kelviq-Partner-Key header on every partner API request.

Query Parameters

external_id

string

If supplied, return only the organization with this partner-side identifier.

Response

List of organizations.

List response for partner organizations.

results

object[]

Show child attributes

count

integer

Total number of organizations matching the query.

Example:

1

Get Started

API Documentation

List partner organizations

Authorizations

Query Parameters

Response