curl --request GET \
--url https://api.stackone.com/v2/connector_profiles/{id} \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://api.stackone.com/v2/connector_profiles/{id}"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://api.stackone.com/v2/connector_profiles/{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.stackone.com/v2/connector_profiles/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>"
],
]);
$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.stackone.com/v2/connector_profiles/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Basic <encoded-value>")
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.stackone.com/v2/connector_profiles/{id}")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.stackone.com/v2/connector_profiles/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"connector_key": "<string>",
"connector": {
"key": "<string>",
"name": "<string>",
"logo_url": "<string>",
"categories": [
"<string>"
],
"release_stage": "<string>",
"authentication_config_label": "<string>"
},
"version": {
"resolved": "<string>",
"pinned": "<string>",
"owner": "<string>"
},
"accounts_count": 123,
"enabled_actions_count": 123,
"active": true,
"default": true,
"environment": "<string>",
"authentication_config_key": "<string>",
"callback_domain": "auth.example.com",
"callback_url": "https://auth.example.com/connect/oauth2/hubspot/callback",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"setup_fields": {},
"secrets": {},
"action_config": {},
"event_config": {
"deel_webhook_employee_created_direct": {
"enabled": true,
"webhook_ids": [
"c4b3f1de-7a2e-4d8b-9f61-5e0a2b7c9d13"
]
},
"deel_webhook_employee_updated_direct": {
"enabled": false,
"webhook_ids": []
}
},
"sync_config": {},
"sync_event_subscriptions": {
"list_employees": [
{
"webhook_id": "wh_2b8d1f9a",
"change_types": [
"added",
"updated",
"removed"
]
}
]
}
}{
"statusCode": 400,
"message": "Bad Request",
"timestamp": "2023-05-30T00:00:00.000Z",
"data": {
"statusCode": 400,
"message": "Bad Request",
"headers": {
"content-type": "application/json",
"x-request-id": "5678c28b211dace4e0a0f9171e6b88c5"
}
},
"provider_errors": [
{
"status": 400,
"url": "https://api.provider.com/v1/resource",
"raw": {
"message": "Invalid input parameters"
},
"headers": {
"content-type": "application/json",
"x-request-id": "5678c28b211dace4e0a0f9171e6b88c5"
}
}
]
}{
"statusCode": 401,
"message": "Unauthorized",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 403,
"message": "Forbidden resource",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 404,
"message": "Not Found",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 408,
"message": "Request timed out",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 409,
"message": "Conflict",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 422,
"message": "Unprocessable Entity",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 429,
"message": "Too many requests",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 500,
"message": "Internal server error",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 501,
"message": "Not Implemented",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 502,
"message": "Bad Gateway",
"timestamp": "2023-05-30T00:00:00.000Z"
}Get a connector profile
Returns the connector profile including its saved setup fields, redacted secrets and action/event/sync configuration, everything needed to pre-fill an edit form.
curl --request GET \
--url https://api.stackone.com/v2/connector_profiles/{id} \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://api.stackone.com/v2/connector_profiles/{id}"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://api.stackone.com/v2/connector_profiles/{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.stackone.com/v2/connector_profiles/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>"
],
]);
$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.stackone.com/v2/connector_profiles/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Basic <encoded-value>")
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.stackone.com/v2/connector_profiles/{id}")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.stackone.com/v2/connector_profiles/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"connector_key": "<string>",
"connector": {
"key": "<string>",
"name": "<string>",
"logo_url": "<string>",
"categories": [
"<string>"
],
"release_stage": "<string>",
"authentication_config_label": "<string>"
},
"version": {
"resolved": "<string>",
"pinned": "<string>",
"owner": "<string>"
},
"accounts_count": 123,
"enabled_actions_count": 123,
"active": true,
"default": true,
"environment": "<string>",
"authentication_config_key": "<string>",
"callback_domain": "auth.example.com",
"callback_url": "https://auth.example.com/connect/oauth2/hubspot/callback",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"setup_fields": {},
"secrets": {},
"action_config": {},
"event_config": {
"deel_webhook_employee_created_direct": {
"enabled": true,
"webhook_ids": [
"c4b3f1de-7a2e-4d8b-9f61-5e0a2b7c9d13"
]
},
"deel_webhook_employee_updated_direct": {
"enabled": false,
"webhook_ids": []
}
},
"sync_config": {},
"sync_event_subscriptions": {
"list_employees": [
{
"webhook_id": "wh_2b8d1f9a",
"change_types": [
"added",
"updated",
"removed"
]
}
]
}
}{
"statusCode": 400,
"message": "Bad Request",
"timestamp": "2023-05-30T00:00:00.000Z",
"data": {
"statusCode": 400,
"message": "Bad Request",
"headers": {
"content-type": "application/json",
"x-request-id": "5678c28b211dace4e0a0f9171e6b88c5"
}
},
"provider_errors": [
{
"status": 400,
"url": "https://api.provider.com/v1/resource",
"raw": {
"message": "Invalid input parameters"
},
"headers": {
"content-type": "application/json",
"x-request-id": "5678c28b211dace4e0a0f9171e6b88c5"
}
}
]
}{
"statusCode": 401,
"message": "Unauthorized",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 403,
"message": "Forbidden resource",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 404,
"message": "Not Found",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 408,
"message": "Request timed out",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 409,
"message": "Conflict",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 422,
"message": "Unprocessable Entity",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 429,
"message": "Too many requests",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 500,
"message": "Internal server error",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 501,
"message": "Not Implemented",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 502,
"message": "Bad Gateway",
"timestamp": "2023-05-30T00:00:00.000Z"
}Authorizations
Query Parameters
A comma-separated list of additional fields to expand. Supported values: connector (the connector this profile configures), version (the connector version this profile resolves to), accounts_count (the number of accounts linked to this profile), callback_url (the OAuth callback URL the provider app must allow for this profile) and enabled_actions_count (how many of that version's actions this profile enables). These are returned as null unless requested.
"connector,version"
Response
The connector profile was retrieved.
How many of the connector version's actions this profile enables. For StackOne connectors only the actions in the release stages your organization can access are counted, so this can read lower than the number the profile actually enables; a connector your organization owns is counted in full. A profile that enables everything counts all of them; one naming individual actions counts only those the version still has. 0 when the profile enables nothing, and also whenever no catalogue can be resolved — an unreadable registry, or a connector whose own release stage your organization cannot access. Always present; null unless requested via ?expand=enabled_actions_count on a read endpoint, and always null on create.
The OAuth or OIDC callback URL to allow in the provider app for this profile. With a callback_domain in use it is always https://<callback_domain>/connect/oauth2/<connector_key>/callback. A callback_domain is in use while the organization's plan includes custom OAuth domains and the hostname is still one of its custom domains serving callbacks, which is an active domain or one pending deletion. Otherwise, or without one, it is the redirectUri set in the setup fields or declared by the connector, otherwise the standard callback path on StackOne's API host. null when the authentication configuration is neither OAuth 2.0 nor OIDC. Always present; null unless requested via ?expand=callback_url.
"https://auth.example.com/connect/oauth2/hubspot/callback"
The saved event action configuration and the webhooks subscribed to each event action, keyed by event action id. Set it with event_config on create or patch.
Show child attributes
Show child attributes
{
"deel_webhook_employee_created_direct": {
"enabled": true,
"webhook_ids": ["c4b3f1de-7a2e-4d8b-9f61-5e0a2b7c9d13"]
},
"deel_webhook_employee_updated_direct": { "enabled": false, "webhook_ids": [] }
}
The webhooks notified of the record changes each sync finds, keyed by action id. Set it with sync_event_subscriptions on create or patch.
Show child attributes
Show child attributes
{
"list_employees": [
{
"webhook_id": "wh_2b8d1f9a",
"change_types": ["added", "updated", "removed"]
}
]
}
Was this page helpful?