Key Sets

Endpointhttps://api.kontier.eu/v1

Key sets: the org-global registries of pricing keys that rate tables and prices resolve against.

List key sets

GET

https://api.kontier.eu/v1

/key-sets

Lists the organization's key sets. include=entries adds each set's keys; entry_count and product_count are sent without being asked until 2026-11-30, after that only with include=entry_count and include=product_count.

Required scope: price.read (Read prices).

List key sets › query Parameters

include

string[] · explode: true

Extra data to add to the response: entries, entry_count, product_count. Send a comma-separated list or repeat the parameter. An unknown name is refused with 400. entry_count is sent without being asked until 2026-11-30; after that date it is sent only when named here. product_count is sent without being asked until 2026-11-30; after that date it is sent only when named here.

Enum values:

entries

entry_count

product_count

limit

integer · min: 1

Page size (default 50, max 200)

Example: 50

cursor

string

Opaque continuation token from the previous response's pagination.cursor. Omit for the first page. Cursors are stateless and do not expire, but are only valid for the list and filters that produced them.

sort

string

Ordering: slug, name or created_at, each with an optional :asc/:desc suffix (default slug:asc). An unknown value is rejected. Cursors are bound to the ordering that issued them, so changing sort mid-walk needs a fresh first page.

List key sets › Headers

X-Workspace-Id

string

Selects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.

Workspace UUID or slug.

List key sets › Responses

array | null · required

object · required

GET/key-sets

curl --request GET \
  --url https://api.kontier.eu/v1/key-sets

shell

Example Responses

{
  "data": [
    {
      "created_at": "2024-08-25T15:00:00Z",
      "deleted_at": "2024-08-25T15:00:00Z",
      "description": "description",
      "entries": [
        {
          "created_at": "2024-08-25T15:00:00Z",
          "display_name": "display_name",
          "id": "71462e7f-87e1-5f14-afc1-afee6cd9b023",
          "key": "key",
          "key_set_id": "0766b726-801e-539f-8001-7c2c6d3561cf",
          "metadata": {
            "key": {}
          },
          "status": "active",
          "tags": [
            "string"
          ],
          "updated_at": "2024-08-25T15:00:00Z"
        }
      ],
      "entry_count": 0,
      "id": "0766b726-801e-539f-8001-7c2c6d3561cf",
      "lifecycle_status": "active",
      "name": "name",
      "organization_id": "24d3775d-4115-5ce8-8a24-75b73041d2ca",
      "product_count": 0,
      "slug": "slug",
      "status": "active",
      "updated_at": "2024-08-25T15:00:00Z"
    }
  ],
  "pagination": {
    "counts": {
      "key": {
        "key": 0
      }
    },
    "cursor": "cursor",
    "has_more": true,
    "total_count": 0
  }
}

json

application/json

Create a key set

POST

https://api.kontier.eu/v1

/key-sets

Creates an org-global key set, optionally seeding entries in the same call (CSV-import flow). Returns the key set in the shape of GET /key-sets/{id}.

Required scope: price.write (Write prices).

Create a key set › query Parameters

include

string[] · explode: true

Extra data to add to the response: entries, entry_count, product_count. Send a comma-separated list or repeat the parameter. An unknown name is refused with 400. entries is sent without being asked until 2026-11-30; after that date it is sent only when named here. entry_count is sent without being asked until 2026-11-30; after that date it is sent only when named here. product_count is sent without being asked until 2026-11-30; after that date it is sent only when named here.

Enum values:

entries

entry_count

product_count

Create a key set › Headers

Idempotency-Key

string · required

Unique key that makes this POST safe to retry: repeats with the same key replay the first response instead of re-executing. Replays are scoped to the retrying principal (same API key / user) and kept for 24 hours. Required on every POST.

Client-generated idempotency key (e.g. a UUID).

X-Workspace-Id

string

Workspace UUID or slug.

Create a key set › Request Body

name

string · maxLength: 200 · required

Display name for the new key set.

slug

string · maxLength: 100 · required

URL-safe unique identifier for the new key set, matching ^[a-z0-9][a-z0-9_-]{0,63}$.

Example: regions

description

string · maxLength: 2000

Optional description of the set.

array | null · maxItems: 1000

Optional keys to seed the set with in the same call; validated like UpsertEntries.

Create a key set › Responses

Created

object · required

POST/key-sets

curl --request POST \
  --url https://api.kontier.eu/v1/key-sets \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <string>' \
  --data '
{
  "description": "description",
  "entries": [
    {
      "display_name": "display_name",
      "key": "key",
      "metadata": {
        "key": {}
      },
      "status": "status",
      "tags": [
        "string"
      ]
    }
  ],
  "name": "name",
  "slug": "regions"
}
'

shell

Example Request Body

{
  "description": "description",
  "entries": [
    {
      "display_name": "display_name",
      "key": "key",
      "metadata": {
        "key": {}
      },
      "status": "status",
      "tags": [
        "string"
      ]
    }
  ],
  "name": "name",
  "slug": "regions"
}

json

Example Responses

{
  "data": {
    "created_at": "2024-08-25T15:00:00Z",
    "deleted_at": "2024-08-25T15:00:00Z",
    "description": "description",
    "entries": [
      {
        "created_at": "2024-08-25T15:00:00Z",
        "display_name": "display_name",
        "id": "71462e7f-87e1-5f14-afc1-afee6cd9b023",
        "key": "key",
        "key_set_id": "0766b726-801e-539f-8001-7c2c6d3561cf",
        "metadata": {
          "key": {}
        },
        "status": "active",
        "tags": [
          "string"
        ],
        "updated_at": "2024-08-25T15:00:00Z"
      }
    ],
    "entry_count": 0,
    "id": "0766b726-801e-539f-8001-7c2c6d3561cf",
    "lifecycle_status": "active",
    "name": "name",
    "organization_id": "24d3775d-4115-5ce8-8a24-75b73041d2ca",
    "product_count": 0,
    "slug": "slug",
    "status": "active",
    "updated_at": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Get a key set

GET

https://api.kontier.eu/v1

/key-sets/{id}

Returns one key set in the list's shape. entries, entry_count and product_count are sent without being asked until 2026-11-30; after that each is sent only when named in include.

Required scope: price.read (Read prices).

Get a key set › path Parameters

id

string · uuid · required

Key set ID

Get a key set › query Parameters

include

string[] · explode: true

Enum values:

entries

entry_count

product_count

Get a key set › Headers

X-Workspace-Id

string

Workspace UUID or slug.

Get a key set › Responses

object · required

GET/key-sets/{id}

curl --request GET \
  --url https://api.kontier.eu/v1/key-sets/:id

shell

Example Responses

{
  "data": {
    "created_at": "2024-08-25T15:00:00Z",
    "deleted_at": "2024-08-25T15:00:00Z",
    "description": "description",
    "entries": [
      {
        "created_at": "2024-08-25T15:00:00Z",
        "display_name": "display_name",
        "id": "71462e7f-87e1-5f14-afc1-afee6cd9b023",
        "key": "key",
        "key_set_id": "0766b726-801e-539f-8001-7c2c6d3561cf",
        "metadata": {
          "key": {}
        },
        "status": "active",
        "tags": [
          "string"
        ],
        "updated_at": "2024-08-25T15:00:00Z"
      }
    ],
    "entry_count": 0,
    "id": "0766b726-801e-539f-8001-7c2c6d3561cf",
    "lifecycle_status": "active",
    "name": "name",
    "organization_id": "24d3775d-4115-5ce8-8a24-75b73041d2ca",
    "product_count": 0,
    "slug": "slug",
    "status": "active",
    "updated_at": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Update a key set

PATCH

https://api.kontier.eu/v1

/key-sets/{id}

Updates the name, the description and the status; the slug is immutable. status archived archives the set and is refused with 409 while any product references it (GET /key-sets/{id}/references lists them). Archiving is final: an archived set is not made active again.

Required scope: price.write (Write prices).

Update a key set › path Parameters

id

string · uuid · required

Key set ID

Update a key set › query Parameters

include

string[] · explode: true

Enum values:

entries

entry_count

product_count

Update a key set › Headers

X-Workspace-Id

string

Workspace UUID or slug.

Update a key set › Request Body

description

string · maxLength: 2000

New description; omit to leave unchanged.

name

string · maxLength: 200

New display name; omit to leave unchanged.

status

string · enum

archived archives the set: refused with 409 while a product links it (GET /key-sets/{id}/references lists them). Archiving is final, so active is accepted only on a set that is still active. Omitted leaves it unchanged.

Enum values:

active

archived

Update a key set › Responses

object · required

PATCH/key-sets/{id}

curl --request PATCH \
  --url https://api.kontier.eu/v1/key-sets/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "description",
  "name": "name",
  "status": "active"
}
'

shell

Example Request Body

{
  "description": "description",
  "name": "name",
  "status": "active"
}

json

Example Responses

{
  "data": {
    "created_at": "2024-08-25T15:00:00Z",
    "deleted_at": "2024-08-25T15:00:00Z",
    "description": "description",
    "entries": [
      {
        "created_at": "2024-08-25T15:00:00Z",
        "display_name": "display_name",
        "id": "71462e7f-87e1-5f14-afc1-afee6cd9b023",
        "key": "key",
        "key_set_id": "0766b726-801e-539f-8001-7c2c6d3561cf",
        "metadata": {
          "key": {}
        },
        "status": "active",
        "tags": [
          "string"
        ],
        "updated_at": "2024-08-25T15:00:00Z"
      }
    ],
    "entry_count": 0,
    "id": "0766b726-801e-539f-8001-7c2c6d3561cf",
    "lifecycle_status": "active",
    "name": "name",
    "organization_id": "24d3775d-4115-5ce8-8a24-75b73041d2ca",
    "product_count": 0,
    "slug": "slug",
    "status": "active",
    "updated_at": "2024-08-25T15:00:00Z"
  }
}

json

application/json

deprecated

Archive a key set (terminal)

POST

https://api.kontier.eu/v1

/key-sets/{id}/archive

Deprecated: use PATCH /key-sets/{id} instead. Removed on 2026-11-30.

Archives a key set and returns 200 with the archived key set. Refused (409) while any product references it; the references endpoint lists the blockers. Use PATCH /key-sets/{id} with {"status": "archived"} instead.

Required scope: price.write (Write prices).

Archive a key set (terminal) › path Parameters

id

string · uuid · required

Key set ID

Archive a key set (terminal) › query Parameters

include

string[] · explode: true

Enum values:

entries

entry_count

product_count

Archive a key set (terminal) › Headers

Idempotency-Key

string · required

Client-generated idempotency key (e.g. a UUID).

X-Workspace-Id

string

Workspace UUID or slug.

Archive a key set (terminal) › Responses

object · required

POST/key-sets/{id}/archive

curl --request POST \
  --url https://api.kontier.eu/v1/key-sets/:id/archive \
  --header 'Idempotency-Key: <string>'

shell

Example Responses

{
  "data": {
    "created_at": "2024-08-25T15:00:00Z",
    "deleted_at": "2024-08-25T15:00:00Z",
    "description": "description",
    "entries": [
      {
        "created_at": "2024-08-25T15:00:00Z",
        "display_name": "display_name",
        "id": "71462e7f-87e1-5f14-afc1-afee6cd9b023",
        "key": "key",
        "key_set_id": "0766b726-801e-539f-8001-7c2c6d3561cf",
        "metadata": {
          "key": {}
        },
        "status": "active",
        "tags": [
          "string"
        ],
        "updated_at": "2024-08-25T15:00:00Z"
      }
    ],
    "entry_count": 0,
    "id": "0766b726-801e-539f-8001-7c2c6d3561cf",
    "lifecycle_status": "active",
    "name": "name",
    "organization_id": "24d3775d-4115-5ce8-8a24-75b73041d2ca",
    "product_count": 0,
    "slug": "slug",
    "status": "active",
    "updated_at": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Upsert key set entries

PUT

https://api.kontier.eu/v1

/key-sets/{id}/entries

Bulk-upserts entries by key: existing keys are overwritten (display name, status, tags, metadata), new keys are added. Retire keys by upserting status=retired. Returns the key set in the shape of GET /key-sets/{id}.

Required scope: price.write (Write prices).

Upsert key set entries › path Parameters

id

string · uuid · required

Key set ID

Upsert key set entries › query Parameters

include

string[] · explode: true

Enum values:

entries

entry_count

product_count

Upsert key set entries › Headers

X-Workspace-Id

string

Workspace UUID or slug.

Upsert key set entries › Request Body

array | null · maxItems: 1000 · required

The keys to upsert; each existing key is overwritten and new keys are added.

Upsert key set entries › Responses

object · required

PUT/key-sets/{id}/entries

curl --request PUT \
  --url https://api.kontier.eu/v1/key-sets/:id/entries \
  --header 'Content-Type: application/json' \
  --data '
{
  "entries": [
    {
      "display_name": "display_name",
      "key": "key",
      "metadata": {
        "key": {}
      },
      "status": "status",
      "tags": [
        "string"
      ]
    }
  ]
}
'

shell

Example Request Body

{
  "entries": [
    {
      "display_name": "display_name",
      "key": "key",
      "metadata": {
        "key": {}
      },
      "status": "status",
      "tags": [
        "string"
      ]
    }
  ]
}

json

Example Responses

{
  "data": {
    "created_at": "2024-08-25T15:00:00Z",
    "deleted_at": "2024-08-25T15:00:00Z",
    "description": "description",
    "entries": [
      {
        "created_at": "2024-08-25T15:00:00Z",
        "display_name": "display_name",
        "id": "71462e7f-87e1-5f14-afc1-afee6cd9b023",
        "key": "key",
        "key_set_id": "0766b726-801e-539f-8001-7c2c6d3561cf",
        "metadata": {
          "key": {}
        },
        "status": "active",
        "tags": [
          "string"
        ],
        "updated_at": "2024-08-25T15:00:00Z"
      }
    ],
    "entry_count": 0,
    "id": "0766b726-801e-539f-8001-7c2c6d3561cf",
    "lifecycle_status": "active",
    "name": "name",
    "organization_id": "24d3775d-4115-5ce8-8a24-75b73041d2ca",
    "product_count": 0,
    "slug": "slug",
    "status": "active",
    "updated_at": "2024-08-25T15:00:00Z"
  }
}

json

application/json

List products referencing a key set

GET

https://api.kontier.eu/v1

/key-sets/{id}/references

Returns the products linked to the key set: the products that block archiving it. include=product adds each product's id and name.

Required scope: price.read (Read prices).

List products referencing a key set › path Parameters

id

string · uuid · required

Key set ID

List products referencing a key set › query Parameters

include

string[] · explode: true

Extra data to add to the response: product. Send a comma-separated list or repeat the parameter. An unknown name is refused with 400.

Enum values:

product

List products referencing a key set › Headers

X-Workspace-Id

string

Workspace UUID or slug.

List products referencing a key set › Responses

array | null · required

object · required

Costs Audiences

Kontier Billing API

Key Sets

Endpointhttps://api.kontier.eu/v1

Key sets: the org-global registries of pricing keys that rate tables and prices resolve against.

List key sets

GET

https://api.kontier.eu/v1

/key-sets

Required scope: price.read (Read prices).

List key sets › query Parameters

include

string[] · explode: true

Enum values:

entries

entry_count

product_count

limit

integer · min: 1

Page size (default 50, max 200)

Example: 50

cursor

string

sort

string

List key sets › Headers

X-Workspace-Id

string

Workspace UUID or slug.

List key sets › Responses

array | null · required

object · required

GET/key-sets

curl --request GET \
  --url https://api.kontier.eu/v1/key-sets

shell

Example Responses

{
  "data": [
    {
      "created_at": "2024-08-25T15:00:00Z",
      "deleted_at": "2024-08-25T15:00:00Z",
      "description": "description",
      "entries": [
        {
          "created_at": "2024-08-25T15:00:00Z",
          "display_name": "display_name",
          "id": "71462e7f-87e1-5f14-afc1-afee6cd9b023",
          "key": "key",
          "key_set_id": "0766b726-801e-539f-8001-7c2c6d3561cf",
          "metadata": {
            "key": {}
          },
          "status": "active",
          "tags": [
            "string"
          ],
          "updated_at": "2024-08-25T15:00:00Z"
        }
      ],
      "entry_count": 0,
      "id": "0766b726-801e-539f-8001-7c2c6d3561cf",
      "lifecycle_status": "active",
      "name": "name",
      "organization_id": "24d3775d-4115-5ce8-8a24-75b73041d2ca",
      "product_count": 0,
      "slug": "slug",
      "status": "active",
      "updated_at": "2024-08-25T15:00:00Z"
    }
  ],
  "pagination": {
    "counts": {
      "key": {
        "key": 0
      }
    },
    "cursor": "cursor",
    "has_more": true,
    "total_count": 0
  }
}

json

application/json

Create a key set

POST

https://api.kontier.eu/v1

/key-sets

Creates an org-global key set, optionally seeding entries in the same call (CSV-import flow). Returns the key set in the shape of GET /key-sets/{id}.

Required scope: price.write (Write prices).

Create a key set › query Parameters

include

string[] · explode: true

Enum values:

entries

entry_count

product_count

Create a key set › Headers

Idempotency-Key

string · required

Client-generated idempotency key (e.g. a UUID).

X-Workspace-Id

string

Workspace UUID or slug.

Create a key set › Request Body

name

string · maxLength: 200 · required

Display name for the new key set.

slug

string · maxLength: 100 · required

URL-safe unique identifier for the new key set, matching ^[a-z0-9][a-z0-9_-]{0,63}$.

Example: regions

description

string · maxLength: 2000

Optional description of the set.

array | null · maxItems: 1000

Optional keys to seed the set with in the same call; validated like UpsertEntries.

Create a key set › Responses

Created

object · required

POST/key-sets

curl --request POST \
  --url https://api.kontier.eu/v1/key-sets \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <string>' \
  --data '
{
  "description": "description",
  "entries": [
    {
      "display_name": "display_name",
      "key": "key",
      "metadata": {
        "key": {}
      },
      "status": "status",
      "tags": [
        "string"
      ]
    }
  ],
  "name": "name",
  "slug": "regions"
}
'

shell

Example Request Body

{
  "description": "description",
  "entries": [
    {
      "display_name": "display_name",
      "key": "key",
      "metadata": {
        "key": {}
      },
      "status": "status",
      "tags": [
        "string"
      ]
    }
  ],
  "name": "name",
  "slug": "regions"
}

json

Example Responses

{
  "data": {
    "created_at": "2024-08-25T15:00:00Z",
    "deleted_at": "2024-08-25T15:00:00Z",
    "description": "description",
    "entries": [
      {
        "created_at": "2024-08-25T15:00:00Z",
        "display_name": "display_name",
        "id": "71462e7f-87e1-5f14-afc1-afee6cd9b023",
        "key": "key",
        "key_set_id": "0766b726-801e-539f-8001-7c2c6d3561cf",
        "metadata": {
          "key": {}
        },
        "status": "active",
        "tags": [
          "string"
        ],
        "updated_at": "2024-08-25T15:00:00Z"
      }
    ],
    "entry_count": 0,
    "id": "0766b726-801e-539f-8001-7c2c6d3561cf",
    "lifecycle_status": "active",
    "name": "name",
    "organization_id": "24d3775d-4115-5ce8-8a24-75b73041d2ca",
    "product_count": 0,
    "slug": "slug",
    "status": "active",
    "updated_at": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Get a key set

GET

https://api.kontier.eu/v1

/key-sets/{id}

Returns one key set in the list's shape. entries, entry_count and product_count are sent without being asked until 2026-11-30; after that each is sent only when named in include.

Required scope: price.read (Read prices).

Get a key set › path Parameters

id

string · uuid · required

Key set ID

Get a key set › query Parameters

include

string[] · explode: true

Enum values:

entries

entry_count

product_count

Get a key set › Headers

X-Workspace-Id

string

Workspace UUID or slug.

Get a key set › Responses

object · required

GET/key-sets/{id}

curl --request GET \
  --url https://api.kontier.eu/v1/key-sets/:id

shell

Example Responses

{
  "data": {
    "created_at": "2024-08-25T15:00:00Z",
    "deleted_at": "2024-08-25T15:00:00Z",
    "description": "description",
    "entries": [
      {
        "created_at": "2024-08-25T15:00:00Z",
        "display_name": "display_name",
        "id": "71462e7f-87e1-5f14-afc1-afee6cd9b023",
        "key": "key",
        "key_set_id": "0766b726-801e-539f-8001-7c2c6d3561cf",
        "metadata": {
          "key": {}
        },
        "status": "active",
        "tags": [
          "string"
        ],
        "updated_at": "2024-08-25T15:00:00Z"
      }
    ],
    "entry_count": 0,
    "id": "0766b726-801e-539f-8001-7c2c6d3561cf",
    "lifecycle_status": "active",
    "name": "name",
    "organization_id": "24d3775d-4115-5ce8-8a24-75b73041d2ca",
    "product_count": 0,
    "slug": "slug",
    "status": "active",
    "updated_at": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Update a key set

PATCH

https://api.kontier.eu/v1

/key-sets/{id}

Required scope: price.write (Write prices).

Update a key set › path Parameters

id

string · uuid · required

Key set ID

Update a key set › query Parameters

include

string[] · explode: true

Enum values:

entries

entry_count

product_count

Update a key set › Headers

X-Workspace-Id

string

Workspace UUID or slug.

Update a key set › Request Body

description

string · maxLength: 2000

New description; omit to leave unchanged.

name

string · maxLength: 200

New display name; omit to leave unchanged.

status

string · enum

Enum values:

active

archived

Update a key set › Responses

object · required

PATCH/key-sets/{id}

curl --request PATCH \
  --url https://api.kontier.eu/v1/key-sets/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "description",
  "name": "name",
  "status": "active"
}
'

shell

Example Request Body

{
  "description": "description",
  "name": "name",
  "status": "active"
}

json

Example Responses

{
  "data": {
    "created_at": "2024-08-25T15:00:00Z",
    "deleted_at": "2024-08-25T15:00:00Z",
    "description": "description",
    "entries": [
      {
        "created_at": "2024-08-25T15:00:00Z",
        "display_name": "display_name",
        "id": "71462e7f-87e1-5f14-afc1-afee6cd9b023",
        "key": "key",
        "key_set_id": "0766b726-801e-539f-8001-7c2c6d3561cf",
        "metadata": {
          "key": {}
        },
        "status": "active",
        "tags": [
          "string"
        ],
        "updated_at": "2024-08-25T15:00:00Z"
      }
    ],
    "entry_count": 0,
    "id": "0766b726-801e-539f-8001-7c2c6d3561cf",
    "lifecycle_status": "active",
    "name": "name",
    "organization_id": "24d3775d-4115-5ce8-8a24-75b73041d2ca",
    "product_count": 0,
    "slug": "slug",
    "status": "active",
    "updated_at": "2024-08-25T15:00:00Z"
  }
}

json

application/json

deprecated

Archive a key set (terminal)

POST

https://api.kontier.eu/v1

/key-sets/{id}/archive

Deprecated: use PATCH /key-sets/{id} instead. Removed on 2026-11-30.

Required scope: price.write (Write prices).

Archive a key set (terminal) › path Parameters

id

string · uuid · required

Key set ID

Archive a key set (terminal) › query Parameters

include

string[] · explode: true

Enum values:

entries

entry_count

product_count

Archive a key set (terminal) › Headers

Idempotency-Key

string · required

Client-generated idempotency key (e.g. a UUID).

X-Workspace-Id

string

Workspace UUID or slug.

Archive a key set (terminal) › Responses

object · required

POST/key-sets/{id}/archive

curl --request POST \
  --url https://api.kontier.eu/v1/key-sets/:id/archive \
  --header 'Idempotency-Key: <string>'

shell

Example Responses

{
  "data": {
    "created_at": "2024-08-25T15:00:00Z",
    "deleted_at": "2024-08-25T15:00:00Z",
    "description": "description",
    "entries": [
      {
        "created_at": "2024-08-25T15:00:00Z",
        "display_name": "display_name",
        "id": "71462e7f-87e1-5f14-afc1-afee6cd9b023",
        "key": "key",
        "key_set_id": "0766b726-801e-539f-8001-7c2c6d3561cf",
        "metadata": {
          "key": {}
        },
        "status": "active",
        "tags": [
          "string"
        ],
        "updated_at": "2024-08-25T15:00:00Z"
      }
    ],
    "entry_count": 0,
    "id": "0766b726-801e-539f-8001-7c2c6d3561cf",
    "lifecycle_status": "active",
    "name": "name",
    "organization_id": "24d3775d-4115-5ce8-8a24-75b73041d2ca",
    "product_count": 0,
    "slug": "slug",
    "status": "active",
    "updated_at": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Upsert key set entries

PUT

https://api.kontier.eu/v1

/key-sets/{id}/entries

Required scope: price.write (Write prices).

Upsert key set entries › path Parameters

id

string · uuid · required

Key set ID

Upsert key set entries › query Parameters

include

string[] · explode: true

Enum values:

entries

entry_count

product_count

Upsert key set entries › Headers

X-Workspace-Id

string

Workspace UUID or slug.

Upsert key set entries › Request Body

array | null · maxItems: 1000 · required

The keys to upsert; each existing key is overwritten and new keys are added.

Upsert key set entries › Responses

object · required

PUT/key-sets/{id}/entries

curl --request PUT \
  --url https://api.kontier.eu/v1/key-sets/:id/entries \
  --header 'Content-Type: application/json' \
  --data '
{
  "entries": [
    {
      "display_name": "display_name",
      "key": "key",
      "metadata": {
        "key": {}
      },
      "status": "status",
      "tags": [
        "string"
      ]
    }
  ]
}
'

shell

Example Request Body

{
  "entries": [
    {
      "display_name": "display_name",
      "key": "key",
      "metadata": {
        "key": {}
      },
      "status": "status",
      "tags": [
        "string"
      ]
    }
  ]
}

json

Example Responses

{
  "data": {
    "created_at": "2024-08-25T15:00:00Z",
    "deleted_at": "2024-08-25T15:00:00Z",
    "description": "description",
    "entries": [
      {
        "created_at": "2024-08-25T15:00:00Z",
        "display_name": "display_name",
        "id": "71462e7f-87e1-5f14-afc1-afee6cd9b023",
        "key": "key",
        "key_set_id": "0766b726-801e-539f-8001-7c2c6d3561cf",
        "metadata": {
          "key": {}
        },
        "status": "active",
        "tags": [
          "string"
        ],
        "updated_at": "2024-08-25T15:00:00Z"
      }
    ],
    "entry_count": 0,
    "id": "0766b726-801e-539f-8001-7c2c6d3561cf",
    "lifecycle_status": "active",
    "name": "name",
    "organization_id": "24d3775d-4115-5ce8-8a24-75b73041d2ca",
    "product_count": 0,
    "slug": "slug",
    "status": "active",
    "updated_at": "2024-08-25T15:00:00Z"
  }
}

json

application/json

List products referencing a key set

GET

https://api.kontier.eu/v1

/key-sets/{id}/references

Returns the products linked to the key set: the products that block archiving it. include=product adds each product's id and name.

Required scope: price.read (Read prices).

List products referencing a key set › path Parameters

id

string · uuid · required

Key set ID

List products referencing a key set › query Parameters

include

string[] · explode: true

Extra data to add to the response: product. Send a comma-separated list or repeat the parameter. An unknown name is refused with 400.

Enum values:

product

List products referencing a key set › Headers

X-Workspace-Id

string

Workspace UUID or slug.

List products referencing a key set › Responses

array | null · required

object · required

Costs Audiences