---
title: "This endpoint provides a list of completeness settings, it can be paginated with the pagination=true parameter"
method: GET
path: "/completenesses/settings"
tags: ["Data Enhancement"]
---

# This endpoint provides a list of completeness settings, it can be paginated with the pagination=true parameter

`GET /completenesses/settings`

Retrieves the collection of CompletenessSetting resources.

## Query parameters

- `page` integer
- `limit` integer
- `pagination` boolean
- `order[id]` 'asc' | 'desc'
- `order[documentType.id]` 'asc' | 'desc'
- `order[name]` 'asc' | 'desc'

## Response `200`

CompletenessSetting collection

- CompletenessSettingReadCompletenessSettingOutput[]
  - `color` string, required
  - `fields` string[] — This is an array of field identifiers.
  - `attributes` object[] — This is an array of field identifiers. The field "attributeSet" is deprecated and will be removed after the 2023-10-15
  - `linkTypes` object — This is an array of link types identifiers.
    - `code` string — This is a link type identifier.
    - `minimum` integer — This is the minimum linked items that should be used in order completeness to be done in this specific configuration.
  - `legacyId` integer
  - `id` string, required — This is the unique identifier of the resource
  - `documentTypeCode` string, required — This is the unique identifier of the document type that the resource should be apply to
  - `description` LanguageTranslation — This structure does accept key & values where key has to be a language code configured in your PIM & the value is the value for this field in this language.
    - `fr-FR` string
    - `en-US` string
  - `name` LanguageTranslation, required — This structure does accept key & values where key has to be a language code configured in your PIM & the value is the value for this field in this language.
    - `fr-FR` string
    - `en-US` string
  - `dateModified` string, date-time, nullable — This is an ISO datetime
  - `dateCreated` string, date-time, nullable — This is an ISO datetime

---

[API](https://skmtc.net/quable/apis/quable-pim-api-documentation-v5.md) · [All operations](https://skmtc.net/quable/apis/quable-pim-api-documentation-v5/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/quable/quable-pim-api-documentation-v5/versions/1641096abb34/schema)