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>'
{
  "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"
    },
    // ...
  ]
}

Documentation Index

Fetch the complete documentation index at: https://sequin.io/docs/llms.txt

Use this file to discover all available pages before exploring further.

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 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"
    },
    // ...
  ]
}