---
title: "Get data collection specification"
method: GET
path: "/connections/{id}/data/{dataCollectionKey}"
tags: ["DataCollections"]
---

# Get data collection specification

`GET /connections/{id}/data/{dataCollectionKey}`

## Path parameters

- `id` string, required
- `dataCollectionKey` string, required

## Query parameters

- `collectionParams` object

## Response `200`

- DataCollectionSpecDto
  - `type` 'collection', required
  - `key` string
  - `name` string, required
  - `parametersSchema` DataCollectionSpecDtoSchema0
    - `title` string
    - `description` string
    - `type` union
      - string
      - string[]
    - `format` string
    - `properties` object
    - `items` DataCollectionSpecDtoSchema0 — recursive
    - `additionalProperties` union
      - boolean
      - DataCollectionSpecDtoSchema0 — recursive
    - `enum` union[]
      - union
        - string
        - number
    - `referenceRecords` object[]
    - `referenceCollection` object
      - `key` object
      - `parameters` object
    - `referenceUdm` string
    - `default` object
    - `allowCustom` boolean
    - `$ref` string
    - `required` string[]
    - `minLength` number
    - `maxLength` number
    - `minimum` number
    - `maximum` number
    - `maxItems` number
    - `readOnly` boolean
    - `writeOnly` boolean
    - `examples` object[]
    - `anyOf` DataCollectionSpecDtoSchema0[]
    - `isImplied` boolean
    - `isSensitive` boolean
    - `referenceCollectionPath` string
    - `referenceCollectionUri` string
  - `fieldsSchema` DataCollectionSpecDtoSchema0
    - `title` string
    - `description` string
    - `type` union
      - string
      - string[]
    - `format` string
    - `properties` object
    - `items` DataCollectionSpecDtoSchema0 — recursive
    - `additionalProperties` union
      - boolean
      - DataCollectionSpecDtoSchema0 — recursive
    - `enum` union[]
      - union
        - string
        - number
    - `referenceRecords` object[]
    - `referenceCollection` object
      - `key` object
      - `parameters` object
    - `referenceUdm` string
    - `default` object
    - `allowCustom` boolean
    - `$ref` string
    - `required` string[]
    - `minLength` number
    - `maxLength` number
    - `minimum` number
    - `maximum` number
    - `maxItems` number
    - `readOnly` boolean
    - `writeOnly` boolean
    - `examples` object[]
    - `anyOf` DataCollectionSpecDtoSchema0[]
    - `isImplied` boolean
    - `isSensitive` boolean
    - `referenceCollectionPath` string
    - `referenceCollectionUri` string
  - `list` object
    - `apiRequests` object[]
      - `path` object, required
      - `method` object, required
    - `filterFields` string[]
  - `search` object
    - `apiRequests` object[]
      - `path` object, required
      - `method` object, required
  - `match` object
    - `apiRequests` object[]
      - `path` object, required
      - `method` object, required
    - `fields` string[]
  - `findById` object
    - `apiRequests` object[]
      - `path` object, required
      - `method` object, required
  - `create` object
    - `apiRequests` object[]
      - `path` object, required
      - `method` object, required
    - `fields` string[]
    - `requiredFields` string[]
    - `excludedFields` string[]
  - `update` object
    - `apiRequests` object[]
      - `path` object, required
      - `method` object, required
    - `fields` string[]
    - `excludedFields` string[]
  - `delete` object
    - `apiRequests` object[]
      - `path` object, required
      - `method` object, required
  - `events` object
    - `created` object
      - `type` 'push' | 'pull', required
      - `isFullScan` boolean
      - `isIdOnly` boolean
    - `updated` object
      - `type` 'push' | 'pull', required
      - `isFullScan` boolean
      - `isIdOnly` boolean
    - `deleted` object
      - `type` 'push' | 'pull', required
      - `isFullScan` boolean
      - `isIdOnly` boolean
    - `all` object
      - `type` 'push' | 'pull', required
      - `isFullScan` boolean
      - `isIdOnly` boolean
  - `customFields` boolean
  - `udm` object
  - `find` object
    - `apiRequests` object[]
      - `path` object, required
      - `method` object, required
    - `queryFields` string[]

---

[API](https://skmtc.net/integration/apis/membrane-api.md) · [All operations](https://skmtc.net/integration/apis/membrane-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/integration/membrane-api/versions/1db9c5a3d78c/schema)