List provider keys
curl --request GET \
--url https://api.getoneprofile.ai/provider-keys/ \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.getoneprofile.ai/provider-keys/"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.getoneprofile.ai/provider-keys/', 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.getoneprofile.ai/provider-keys/",
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-API-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://api.getoneprofile.ai/provider-keys/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
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.getoneprofile.ai/provider-keys/")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getoneprofile.ai/provider-keys/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": [
{
"company_domain": "<string>",
"credential_fields": [
{
"guide": "<string>",
"label": "<string>",
"name": "<string>",
"required": true,
"secret": true
}
],
"enrichments": [
"<string>"
],
"integration_type": "<string>",
"key": {
"checked_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"created_by_user_id": "<string>",
"credits_remaining": 123,
"health": "unchecked",
"health_detail": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"integration_type": "<string>",
"key_hint": "<string>",
"provider_name": "<string>",
"running_low": true,
"updated_at": "2023-11-07T05:31:56Z",
"updated_by_user_id": "<string>"
},
"provider_name": "<string>",
"reports_balance": true
}
],
"next_page_cursor": "<string>",
"previous_page_cursor": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>",
"issues": [
{
"input": "<string>",
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}provider-keys
List provider keys
Every provider the workspace can bring its own key for, by name, with its key if it has one (never the key itself: its last four characters and how it stands). A key held with a provider no enrichment asks any more is listed too, with nothing to fill in, so it can still be checked and removed. The plan, the default order and the key fee are the settings read.
GET
/
provider-keys
/
List provider keys
curl --request GET \
--url https://api.getoneprofile.ai/provider-keys/ \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.getoneprofile.ai/provider-keys/"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.getoneprofile.ai/provider-keys/', 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.getoneprofile.ai/provider-keys/",
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-API-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://api.getoneprofile.ai/provider-keys/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
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.getoneprofile.ai/provider-keys/")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getoneprofile.ai/provider-keys/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": [
{
"company_domain": "<string>",
"credential_fields": [
{
"guide": "<string>",
"label": "<string>",
"name": "<string>",
"required": true,
"secret": true
}
],
"enrichments": [
"<string>"
],
"integration_type": "<string>",
"key": {
"checked_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"created_by_user_id": "<string>",
"credits_remaining": 123,
"health": "unchecked",
"health_detail": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"integration_type": "<string>",
"key_hint": "<string>",
"provider_name": "<string>",
"running_low": true,
"updated_at": "2023-11-07T05:31:56Z",
"updated_by_user_id": "<string>"
},
"provider_name": "<string>",
"reports_balance": true
}
],
"next_page_cursor": "<string>",
"previous_page_cursor": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>",
"issues": [
{
"input": "<string>",
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}Query Parameters
Response
Successful Response
Was this page helpful?