List End User Integrations - Versori User Documentation

GET

embed

{hub_id}

users

{user_id}

integrations

List End User Integrations

curl --request GET \
  --url https://platform.versori.com/api/embedded/v1/embed/{hub_id}/users/{user_id}/integrations \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://platform.versori.com/api/embedded/v1/embed/{hub_id}/users/{user_id}/integrations"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://platform.versori.com/api/embedded/v1/embed/{hub_id}/users/{user_id}/integrations', 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://platform.versori.com/api/embedded/v1/embed/{hub_id}/users/{user_id}/integrations",
  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: Bearer <token>"
  ],
]);

$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://platform.versori.com/api/embedded/v1/embed/{hub_id}/users/{user_id}/integrations"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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://platform.versori.com/api/embedded/v1/embed/{hub_id}/users/{user_id}/integrations")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "totalCount": 123,
  "integrations": [
    {
      "id": "<string>",
      "name": "<string>",
      "imageUrl": "<string>",
      "description": "<string>",
      "isDeployed": true,
      "isActivated": true,
      "variablesSchema": {}
    }
  ],
  "next": "<string>",
  "prev": "<string>",
  "totalConnected": 123
}

{
  "code": "<string>",
  "message": "<string>",
  "fields": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "details": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

hub_id

string<ulid>

required

user_id

string

required

UserID references an End User in the Hub.

Most APIs support setting this value to either the internal Versori identifier or their external ID as determined by the organisation. The identifier_type query parameter is used to indicate which type of ID is being used.

Query Parameters

deployed

boolean

Deployed allowing filtering integrations to only return either deployed (true) or not deployed (false) integrations.

If not set, all integrations are returned.

identifier_type

enum<string>

default:external

IdentifierType indicates whether the user_id path parameter is a internal identifier created by Versori, or an external identifier. If the value is external, some endpoints also require the hub query parameter to identify the correct Hub.

Available options:

internal,

external

Response

EndUserIntegrationPage is a paginated list of integrations to be displayed to the user when embedding the integration hub.

totalCount

integer

required

integrations

object[]

required

Show child attributes

string

totalConnected

integer

TotalConnected is the total number of integrations that are connected for the end user. This can be used to display a badge on the embedded integration hub to show the user how many integrations they have connected.

⌘I

List End User Integrations

curl --request GET \
  --url https://platform.versori.com/api/embedded/v1/embed/{hub_id}/users/{user_id}/integrations \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://platform.versori.com/api/embedded/v1/embed/{hub_id}/users/{user_id}/integrations"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://platform.versori.com/api/embedded/v1/embed/{hub_id}/users/{user_id}/integrations', 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://platform.versori.com/api/embedded/v1/embed/{hub_id}/users/{user_id}/integrations",
  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: Bearer <token>"
  ],
]);

$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://platform.versori.com/api/embedded/v1/embed/{hub_id}/users/{user_id}/integrations"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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://platform.versori.com/api/embedded/v1/embed/{hub_id}/users/{user_id}/integrations")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "totalCount": 123,
  "integrations": [
    {
      "id": "<string>",
      "name": "<string>",
      "imageUrl": "<string>",
      "description": "<string>",
      "isDeployed": true,
      "isActivated": true,
      "variablesSchema": {}
    }
  ],
  "next": "<string>",
  "prev": "<string>",
  "totalConnected": 123
}

{
  "code": "<string>",
  "message": "<string>",
  "fields": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "details": "<string>"
}