Skip to main content
GET
/
v1
/
collections
/
{credential_id}
/
{id}
Get a collection
curl --request GET \
  --url https://api.sequin.io/v1/collections/{credential_id}/{id} \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.sequin.io/v1/collections/{credential_id}/{id}"

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

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

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.sequin.io/v1/collections/{credential_id}/{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.sequin.io/v1/collections/{credential_id}/{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.sequin.io/v1/collections/{credential_id}/{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.sequin.io/v1/collections/{credential_id}/{id}")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.sequin.io/v1/collections/{credential_id}/{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": "stripe:upcoming_line_item",
  "name": "upcoming_line_item",
  "upstream_id": "stripe:upcoming_line_item",
  "fields": [
    {
      "accessor": "id",
      "id": "stripe:customer:id",
      "name": "id",
      "primary_key": true,
      "type": "text"
    },
    {
      "accessor": "name",
      "id": "stripe:customer:name",
      "name": "name",
      "primary_key": false,
      "type": "text"
    },
    {
      "accessor": "balance",
      "id": "stripe:customer:balance",
      "name": "balance",
      "primary_key": false,
      "type": "number"
    },
    // ...
  ]
}

​
Request parameters

​
credential_id
string
required
ID of the credential.
​
id
string
required
ID of the collection.
​
include
string
A comma-separated list of optional fields to include in the response. Defaults to blank, which does not return optional fields.Optional fields:
  • upstream_metadata: Include extended metadata for the collection and collection fields from the upstream provider. This field is supported by Airtable only and is experimental.

​
Response fields

​
id
string
ID of the collection.
​
upstream_id
string
ID of the collection as defined by the provider.
​
name
string
Name of the collection.
​
links
array
Links to documentation for the collection.
Coming soon
​
fields
array
Fields for the collection.
{
  "id": "stripe:upcoming_line_item",
  "name": "upcoming_line_item",
  "upstream_id": "stripe:upcoming_line_item",
  "fields": [
    {
      "accessor": "id",
      "id": "stripe:customer:id",
      "name": "id",
      "primary_key": true,
      "type": "text"
    },
    {
      "accessor": "name",
      "id": "stripe:customer:name",
      "name": "name",
      "primary_key": false,
      "type": "text"
    },
    {
      "accessor": "balance",
      "id": "stripe:customer:balance",
      "name": "balance",
      "primary_key": false,
      "type": "number"
    },
    // ...
  ]
}