GET
/
v1
/
collections
/
{credential_id}
curl --request GET \
  --url https://api.sequin.io/v1/collections/{credential_id} \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "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

The collections for this credential will be listed.

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.