List claims

Retrieve claim definitions — the canonical records (Non-GMO, Vegan, Gluten-Free, …) that products are then assigned to. Filterable by label, code, and category. Paginated.

GET /certifications/api/v1/claims

List claims

cURL

curl --request GET \
  --url https://www.closient.com/certifications/api/v1/claims \
  --header 'X-API-Key: <api-key>'

200

{
  "data": [
    {
      "id": "<string>",
      "code": "<string>",
      "label": "<string>",
      "requires_definition": true,
      "description": ""
    }
  ],
  "pagination": {
    "page": 2,
    "page_size": 2,
    "total_count": 1,
    "total_pages": 2,
    "has_next": true,
    "has_previous": true
  }
}

Authorizations

APIKeyHeaderAuthOAuthTokenAuthSessionAuth

X-API-Key · string · header · required

Query Parameters

label · string | null

Filter by label (case-insensitive partial match).

code · string | null

Filter by exact code (case-insensitive).

category · enum<string> | null

Filter by category. One of DIETARY, INGREDIENT_ABSENCE, ALLERGEN_FREE, PROCESS, SUSTAINABILITY, OTHER.

Available options: DIETARY, INGREDIENT_ABSENCE, ALLERGEN_FREE, PROCESS, SUSTAINABILITY, OTHER

ordering · string | null

Sort field. One of label, code, -label, -code.

Pattern: ^-?(label|code)$

page · integer · default: 1

Page number (1-indexed).

Required range: x >= 1

page_size · integer · default: 25

Number of items per page (max 100).

Required range: 1 <= x <= 100

Response

200 - application/json

OK

data · ClaimListOut · object[] · required

Items on the current page, each conforming to the endpoint's item schema. Empty when the result set is empty or page is past the end.

Show child attributes

pagination · PaginationMeta · object · required

Pagination envelope describing position within the full result set.

Show child attributes

Example:

{
  "has_next": true,
  "has_previous": false,
  "page": 1,
  "page_size": 25,
  "total_count": 342,
  "total_pages": 14
}