# API configuration details
API keys can be added or updated through [Settings](/reference/settings.md) > [Integration](/reference/settings/integration.md) > [API configuration](/reference/settings/integration/api-configuration.md).
### Name
The name for this API key.
### API key
API key used to connect to the PIM API. This is automatically generated.
### API URL
URL where the API is available.
### API endpoint access
{% hint style="info" %}
**Tip** Use the search bar, "Check all", "Expand all" and "Collapse all" options to quickly enable the endpoints you want to allow the API key to access.
{% endhint %}
| Archive reasons | |
| ---------------------- | ---------------------------------------------------------- |
| Create archive reasons | Allow this API key to create archive reasons in the system |
| Delete archive reasons | Allow this API key to delete archive reasons in the system |
| Get archive reasons | Allow this API key to get archive reasons in the system |
| Update archive reasons | Allow this API key to update archive reasons in the system |
| Asset folders | |
| -------------------- | -------------------------------------------------------- |
| Create asset folders | Allow this API key to create asset folders in the system |
| Delete asset folders | Allow this API key to delete asset folders in the system |
| Get asset folders | Allow this API key to get asset folders in the system |
| Update asset folders | Allow this API key to update asset folders in the system |
| Assets | |
| -------------------------------- | -------------------------------------------------------------------- |
| Create assets | Allow this API key to create assets in the system |
| Delete assets | Allow this API key to delete assets in the system |
| Get asset enrichment insights | Allow this API key to get asset enrichment insights in the system |
| Get assets | Allow this API key to get assets in the system |
| Search assets | Allow this API key to search assets in the system |
| Update asset enrichment insights | Allow this API key to update asset enrichment insights in the system |
| Update assets | Allow this API key to update assets in the system |
| Asset types | |
| ------------------ | ---------------------------------------------------------- |
| Create asset types | Allow this API key to create new asset types in the system |
| Delete asset types | Allow this API key to delete asset types in the system |
| Get asset types | Allow this API key to get asset types in the system |
| Update asset types | Allow this API key to update asset types in the system |
| Attributes | |
| ----------------------- | ----------------------------------------------------------- |
| Create attribute groups | Allow this API key to create attribute groups in the system |
| Create attributes | Allow this API key to create attributes in the system |
| Create attribute scopes | Allow this API key to create attribute scopes in the system |
| Delete attribute groups | Allow this API key to delete attribute groups in the system |
| Delete attributes | Allow this API key to delete attributes in the system |
| Delete attribute scopes | Allow this API key to delete attribute scopes in the system |
| Get attribute groups | Allow this API key to get attribute groups in the system |
| Get attributes | Allow this API key to get attributes in the system |
| Get attribute scopes | Allow this API key to get attribute scopes in the system |
| Update attribute groups | Allow this API key to update attribute groups in the system |
| Update attributes | Allow this API key to update attributes in the system |
| Update attribute scopes | Allow this API key to update attribute scopes in the system |
| Business units | |
| --------------------- | ----------------------------------------------------------- |
| Create business units | Allow API key access to create business units in the system |
| Delete business units | Allow API key access to delete business units in the system |
| Get business units | Allow API key access to get business units in the system |
| Update business units | Allow API key access to update business units in the system |
| Product catalogues | |
| ----------------------------------- | ----------------------------------------------------------------------- |
| Create categories | Allow this API key to create categories in the system |
| Create catalogues | Allow this API key to create catalogues in the system |
| Delete categories | Allow this API key to delete categories in the system |
| Delete catalogues | Allow this API key to delete catalogues in the system |
| Get categories | Allow this API key to get categories in the system |
| Get category enrichment insights | Allow this API key to get category enrichment insights in the system |
| Get product catalogues | Allow this API key to get product catalogues in the system |
| Search categories | Allow this API key to search categories in the system |
| Update categories | Allow this API key to update categories in the system |
| Update category enrichment insights | Allow this API key to update category enrichment insights in the system |
| Update product catalogues | Allow this API key to update product catalogues in the system |
| Dimensions | |
| ----------------- | ----------------------------------------------------- |
| Create dimensions | Allow this API key to create dimensions in the system |
| Delete dimensions | Allow this API key to delete dimensions in the system |
| Get dimensions | Allow this API key to get dimensions in the system |
| Update dimensions | Allow this API key to update dimensions in the system |
| Enrichment insight setups | |
| -------------------------------- | -------------------------------------------------------------------- |
| Create enrichment insight setups | Allow this API key to create enrichment insight setups in the system |
| Delete enrichment insight setups | Allow this API key to delete enrichment insight setups in the system |
| Get enrichment insight setups | Allow this API key to get enrichment insight setups in the system |
| Update enrichment insight setups | Allow this API key to update enrichment insight setups in the system |
| Export | |
| ------------ | ---------------------------------------------------------------------------------- |
| Build export | Allow this API key to build exports using the build in export system of Struct PIM |
| Global lists | |
| -------------------------- | -------------------------------------------------------------- |
| Create global list folders | Allow this API key to create global list folders in the system |
| Create global lists | Allow this API key to create global lists in the system |
| Create global list values | Allow this API key to create global list values in the system |
| Delete global list folders | Allow this API key to delete global list folders in the system |
| Delete global lists | Allow this API key to delete global lists in the system |
| Delete global list values | Allow this API key to delete global list values in the system |
| Get global list folders | Allow this API key to get global list folders in the system |
| Get global lists | Allow this API key to get global lists in the system |
| Get global list values | Allow this API key to get global list values in the system |
| Search global lists | Allow this API key to search global lists in the system |
| Update global list folders | Allow this API key to update global list folders in the system |
| Update global lists | Allow this API key to update global lists in the system |
| Update global list values | Allow this API key to update global list values in the system |
| General | |
| ---------------- | ----------------------------------------------------------------------------------------- |
| Create languages | Allow this API key to create languages in the system |
| Delete languages | Allow this API key to delete languages in the system |
| Update languages | Allow this API key to update languages in the system |
| Model generator | Allow this API key to generate models for products, variants, categories and global-lists |
| Maintenance | |
| ----------- | ---------------------------------------------------------- |
| Maintenance | Allow users access to start maintenance jobs in the system |
| Messaging | |
| --------------------- | ---------------------------------------------------------------------------------- |
| Create message queue | Allow API key access to create messaging queue connection configured in the system |
| Delete message queue | Allow API key access to delete message queue connection configured in the system |
| Get messaging queues | Allow API key access to get messaging queues configured in the system |
| Update message queues | Allow API key access to update message queues configured in the system |
| Products | |
| ------------------------------------------ | ----------------------------------------------------------- |
| Create products | Allow API key access to creating new products in the system |
| Delete products | Allow requests with this API key to delete products |
| Get product enrichment insights | Allow fetching enrichment insights for products |
| Get products | Allow fetching products and associated data |
| Search products | Allow requests with this API key to search products |
| Enable/disable product enrichment insights | Allow disabling and enabling insights for specific products |
| Update products | Allow requests with this API key to update products |
| Product structures | |
| ------------------------- | ------------------------------------------------------------- |
| Create product structures | Allow this API key to create product structures in the system |
| Delete product structures | Allow this API key to delete product structures in the system |
| Get product structures | Allow this API key to get product structures in the system |
| Update product structures | Allow this API key to update product structures in the system |
| Security | |
| ---------------------------------------- | ------------------------------------------------------------------------------------ |
| Create permissions and permission groups | Allow API key access to creating new permissions and permission groups in the system |
| Delete permissions and permission groups | Allow requests with this API key to delete permissions and permission groups |
| Get permissions and permission groups | Allow fetching permissions and permission groups |
| Update permissions and permission groups | Allow requests with this API key to update permissions and permission groups |
| Transactions | |
| ----------------------- | ------------------------------------------------------------------------------------- |
| Get transaction changes | Allow this API key to get information on the changes made to entities in transactions |
| Get transactions | Allow this API key to get transactions in the system |
| Users | |
| ------------ | ------------------------------------------------ |
| Create users | Allow this API key to create users in the system |
| Delete users | Allow this API key to delete users in the system |
| Get users | Allow this API key to get users in the system |
| Update users | Allow this API key to update users in the system |
| User groups | |
| ------------------ | ------------------------------------------------------ |
| Create user groups | Allow this API key to create user groups in the system |
| Delete user groups | Allow this API key to delete user groups in the system |
| Get user groups | Allow this API key to get user groups in the system |
| Update user groups | Allow this API key to update user groups in the system |
| Roles | |
| ------------ | -------------------------------------------------- |
| Create roles | Allow API key access to create roles in the system |
| Delete roles | Allow API key access to delete roles in the system |
| Get roles | Allow API key access to get roles in the system |
| Update roles | Allow API key access to update roles in the system |
| User tasks | |
| ------------------------- | ------------------------------------------------------------- |
| Create user task comments | Allow this API key to create user task comments in the system |
| Create user tasks | Allow this API key to create user tasks in the system |
| Delete user task comments | Allow this API key to delete user task comments in the system |
| Delete user tasks | Allow this API key to delete user tasks in the system |
| Get user tasks | Allow this API key to get user tasks in the system |
| Update user task comments | Allow this API key to update user task comments in the system |
| Update user tasks | Allow this API key to update user tasks in the system |
| Variants | |
| ------------------------------------------ | ----------------------------------------------------------- |
| Create variants | Allow API key access to creating new variants in the system |
| Delete variants | Allow requests with this API key to delete variants |
| Get variant enrichment insights | Allow fetching enrichment insights for variants |
| Get variants | Allow fetching variants and associated data |
| Search variants | Allow requests with this API key to search variants |
| Enable/disable variant enrichment insights | Allow disabling and enabling insights for specific variants |
| Update variants | Allow requests with this API key to update variants |
| Variant groups | |
| ------------------------------------------------ | ------------------------------------------------------------------------- |
| Create variant groups | Allow this API key to create variant groups in the system |
| Delete variant groups | Allow this API key to delete variant groups in the system |
| Get variant group enrichment insights | Allow this API key to get variant group enrichment insights in the system |
| Get variant groups | Allow this API key to get variant groups in the system |
| Search variant groups | Allow this API key to search variant groups in the system |
| Enable/disable variant group enrichment insights | Allow disabling and enabling insights for specific variant groups |
| Update variant groups | Allow this API key to update variant groups in the system |
| Webhooks | |
| --------------- | ---------------------------------------------------------------- |
| Create webhooks | Allow API key access to create webhooks configured in the system |
| Delete webhooks | Allow API key access to delete webhooks configured in the system |
| Get webhooks | Allow API key access to get webhooks configured in the system |
| Update webhooks | Allow API key access to update webhooks configured in the system |
| Workflows | |
| ---------------- | ------------------------------------------------------ |
| Create workflows | Allow this API key to create workflows in the system |
| Delete workflows | Allow this API key to delete workflows in the system |
| Get workflows | Allow this API key to get workflows in the system |
| Update workflows | Allow API key access to update languages in the system |
| Saved search | |
| -------------------------- | --------------------------------------------------------------- |
| Create saved search | Allow this API key to create saved searches in the system |
| Create saved search folder | Allow this API key to create saved search folders in the system |
| Delete saved search | Allow this API key to delete saved searches in the system |
| Delete saved search folder | Allow this API key to delete saved search folders in the system |
| Get saved search | Allow this API key to get saved searches in the system |
| Get saved search folder | Allow this API key to get saved search folders in the system |
| Update saved search | Allow this API key to update saved searches in the system |
| Update saved search folder | Allow this API key to update saved search folders in the system |
| Publications | |
| ---------------------- | --------------------------------------------------------------------------------------- |
| Get print publications | Allow API key access to getting configured print publications in the Publication Module |
| Browse endpoints | |
| --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| | Set [Basic settings](/reference/settings/integration/api-configuration/api-configuration-details/api-configuration-basic-settings.md) |
| Browse products | Allow this API key to get products.
Enabling this reveals additional advanced settings.
|
| Browse variants | Allow this API key to get variants.
Enabling this reveals additional advanced settings.
|
| Browse variant groups | Allow this API key to get variant groups.
Enabling this reveals additional advanced settings.
|
| Browse categories | Allow this API key to get categories.
Enabling this reveals additional advanced settings.
|
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://docs.struct.com/reference/settings/integration/api-configuration/api-configuration-details.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.