> ## 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.

# List collections

> This endpoint lists all the collections for a credential.

## Request parameters

<ParamField path="credential_id" type="string" required>
  The collections for this credential will be listed.
</ParamField>

<ParamField path="include" type="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.
</ParamField>

## Response fields

<ResponseField name="id" type="string">
  ID of the collection.
</ResponseField>

<ResponseField name="upstream_id" type="string">
  ID of the collection as defined by the provider.
</ResponseField>

<ResponseField name="name" type="string">
  Name of the collection.
</ResponseField>

<ResponseField name="links" type="array">
  Links to documentation for the collection.

  <Note>Coming soon</Note>
</ResponseField>

<ResponseField name="fields" type="array">
  Fields for the collection.

  <Expandable>
    <ResponseField name="id" type="string">
      The ID of the field. This is a unique identifier for the field that will not change.
    </ResponseField>

    <ResponseField name="name" type="string">
      Human readable name of this field.
    </ResponseField>

    <ResponseField name="accessor" type="string">
      The key that the provider uses for this field.
    </ResponseField>

    <ResponseField name="type" type="string">
      The data type of the field.
    </ResponseField>

    <ResponseField name="primary_key" type="boolean">
      Whether this field is a primary key of this collection.
    </ResponseField>

    <ResponseField name="metadata" type="object">
      Additional metadata about the field.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseExample>
  ```json 200 OK theme={null}
  {
    "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"
          },
          // ...
        ]
      }
      { ... },
      { ... }
    ]
  }
  ```
</ResponseExample>