List integration connections

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/integration_connections?limit=20&filter_status=ACTIVE" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.integrationConnections.getIntegrationConnections({limit: 20, filter_status: 'ACTIVE'});
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->integrationConnections->getIntegrationConnections([
    'limit' => 20,
    'filter_status' => 'ACTIVE',
]);
print_r($response->data);

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.integration_connections.integration_connections_dto.IntegrationConnectionsDto;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<IntegrationConnectionsDto.IntegrationConnections> response = client.integrationConnections().getIntegrationConnections(
        Map.of("limit", 20, "filter_status", "ACTIVE"));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.IntegrationConnections.GetIntegrationConnectionsAsync(new Dictionary<string, object?> { ["limit"] = 20, ["filter_status"] = "ACTIVE" });

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.integrationConnections
    .getIntegrationConnections(
      queryParams: {'limit': 20, 'filter_status': 'ACTIVE'},
    );
print(response.map);

import (
	"context"
	"fmt"
	"log"

	exsited "github.com/exsited/exsited-sdk-go/v4"
)

client, err := exsited.BuildClient(nil)
if err != nil {
	log.Fatal(err)
}
defer client.Close()

response, err := client.IntegrationConnections().GetIntegrationConnections(context.Background(), map[string]any{"limit": 20, "filter_status": "ACTIVE"}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "object": "<string>",
  "url": "<string>",
  "data": [
    {}
  ],
  "pagination": {
    "limit": 123,
    "has_more": true,
    "next_cursor": "<string>",
    "prev_cursor": "<string>",
    "links": {
      "next": "<string>",
      "prev": "<string>"
    }
  }
}

{
  "object": "<string>",
  "request_id": "<string>",
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "doc_url": "<string>",
  "errors": [
    {
      "field": "<string>",
      "code": "<string>",
      "message": "<string>",
      "doc_url": "<string>"
    }
  ]
}

GET

integration_connections

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/integration_connections?limit=20&filter_status=ACTIVE" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.integrationConnections.getIntegrationConnections({limit: 20, filter_status: 'ACTIVE'});
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->integrationConnections->getIntegrationConnections([
    'limit' => 20,
    'filter_status' => 'ACTIVE',
]);
print_r($response->data);

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.integration_connections.integration_connections_dto.IntegrationConnectionsDto;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<IntegrationConnectionsDto.IntegrationConnections> response = client.integrationConnections().getIntegrationConnections(
        Map.of("limit", 20, "filter_status", "ACTIVE"));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.IntegrationConnections.GetIntegrationConnectionsAsync(new Dictionary<string, object?> { ["limit"] = 20, ["filter_status"] = "ACTIVE" });

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.integrationConnections
    .getIntegrationConnections(
      queryParams: {'limit': 20, 'filter_status': 'ACTIVE'},
    );
print(response.map);

import (
	"context"
	"fmt"
	"log"

	exsited "github.com/exsited/exsited-sdk-go/v4"
)

client, err := exsited.BuildClient(nil)
if err != nil {
	log.Fatal(err)
}
defer client.Close()

response, err := client.IntegrationConnections().GetIntegrationConnections(context.Background(), map[string]any{"limit": 20, "filter_status": "ACTIVE"}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "object": "<string>",
  "url": "<string>",
  "data": [
    {}
  ],
  "pagination": {
    "limit": 123,
    "has_more": true,
    "next_cursor": "<string>",
    "prev_cursor": "<string>",
    "links": {
      "next": "<string>",
      "prev": "<string>"
    }
  }
}

{
  "object": "<string>",
  "request_id": "<string>",
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "doc_url": "<string>",
  "errors": [
    {
      "field": "<string>",
      "code": "<string>",
      "message": "<string>",
      "doc_url": "<string>"
    }
  ]
}

Records are under data, and the listing pages by cursor. Filter by status with filter_status: ACTIVE, INACTIVE or DISCONNECTED. Other fields filter as filter_<field>.

The SDK samples get their client from credentials your app registers once when it starts, as shown in Authentication. To try the call here, click Try it, set host to your Exsited API host name and paste an access token from Get an access token.

Authorizations

Authorization

string

header

required

An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.

Query Parameters

limit

integer

The number of records per page. A limit of 0 returns 400.

Example:

20

cursor

string

The next_cursor from the previous page, to read the next page.

sort

string

The field to sort by; prefix it with - for descending order.

filter_status

enum<string>

Only connections with this status: ACTIVE, INACTIVE or DISCONNECTED. Any other value returns 400.

Available options:

ACTIVE,

INACTIVE,

DISCONNECTED

Example:

"ACTIVE"

Response

One page of integration connections, under data.

object

string

url

string

data

object[]

The integration connections on this page.

pagination

object

Show child attributes

Guides

API reference

Authorizations

Query Parameters

Response