JavaScript
import Indices from 'indicesio';
const client = new Indices({
apiKey: process.env['INDICES_API_KEY'], // This is the default and can be omitted
});
const connector = await client.beta.connectors.retrieve('connector_id');
console.log(connector.id);import os
from indices import Indices
client = Indices(
api_key=os.environ.get("INDICES_API_KEY"), # This is the default and can be omitted
)
connector = client.beta.connectors.retrieve(
"connector_id",
)
print(connector.id)curl --request GET \
--url https://api.indices.io/v1beta/connectors/{connector_id} \
--header 'Authorization: Bearer <token>'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.indices.io/v1beta/connectors/{connector_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: 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://api.indices.io/v1beta/connectors/{connector_id}"
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))
}HttpResponse<String> response = Unirest.get("https://api.indices.io/v1beta/connectors/{connector_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.indices.io/v1beta/connectors/{connector_id}")
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{
"id": "conn_8kPq2mWxYz1aBcDeFgHi3J",
"display_name": "Invoice retrieval",
"purpose": "Retrieve invoices from our ERP system, including refunds.",
"website": "https://example.com",
"input_schema": {},
"output_schema": {},
"revised_from_connector_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"required_secrets": [
{
"name": "amazon_login",
"type": "login",
"supports_totp": false,
"description": "Amazon account whose orders are fetched."
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Connectors
Retrieve a connector
Retrieve a connector by its ID.
GET
/
v1beta
/
connectors
/
{connector_id}
JavaScript
import Indices from 'indicesio';
const client = new Indices({
apiKey: process.env['INDICES_API_KEY'], // This is the default and can be omitted
});
const connector = await client.beta.connectors.retrieve('connector_id');
console.log(connector.id);import os
from indices import Indices
client = Indices(
api_key=os.environ.get("INDICES_API_KEY"), # This is the default and can be omitted
)
connector = client.beta.connectors.retrieve(
"connector_id",
)
print(connector.id)curl --request GET \
--url https://api.indices.io/v1beta/connectors/{connector_id} \
--header 'Authorization: Bearer <token>'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.indices.io/v1beta/connectors/{connector_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: 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://api.indices.io/v1beta/connectors/{connector_id}"
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))
}HttpResponse<String> response = Unirest.get("https://api.indices.io/v1beta/connectors/{connector_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.indices.io/v1beta/connectors/{connector_id}")
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{
"id": "conn_8kPq2mWxYz1aBcDeFgHi3J",
"display_name": "Invoice retrieval",
"purpose": "Retrieve invoices from our ERP system, including refunds.",
"website": "https://example.com",
"input_schema": {},
"output_schema": {},
"revised_from_connector_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"required_secrets": [
{
"name": "amazon_login",
"type": "login",
"supports_totp": false,
"description": "Amazon account whose orders are fetched."
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Enter your API key as the bearer token. Set header: Authorization to Bearer <api_key>
Path Parameters
The ID of the connector to retrieve.
Response
Successful response
Unique identifier for the object.
Example:
"conn_8kPq2mWxYz1aBcDeFgHi3J"
Short human-readable name of the connector.
Example:
"Invoice retrieval"
What the connector does, as specified at publish time.
Example:
"Retrieve invoices from our ERP system, including refunds."
Website the connector operates against.
Example:
"https://example.com"
JSON Schema for the connector's run arguments.
JSON Schema for the connector's run results.
Connector this one revised (if any).
Timestamp when the object was created.
Secret slots that must be bound when running the connector.
Show child attributes
Show child attributes