--- title: "getConfiguration" method: GET path: "/v1/app-configurations/{appId}" tags: ["App Configuration"] --- # getConfiguration `GET /v1/app-configurations/{appId}` Retrieve a specific app configuration ## Query parameters - `version` string ## Response `200` Successful response - Configuration — Configuration data about your app which is versionable - `app_id` string, required - `name` string, required — Name of the app - `author` Author - `name` string — Name of the author - `company` string, required — Company of the author - `email` string — Email of the author - `versions` string[], required — List of available versions of the app - `public_versions` string[] — List of available public versions of the app - `support_email` string — Email address for support requests - `latest_version` string, required — Latest version of the app - `category` string — Category of the app. - `icon_url` string — URL of the app icon. - `documentation_url` string — URL of the app documentation. - `description` object, required — Markdown description of the app. - `en` string, nullable — English translation - `de` string, required — German translation - `notifications` object — Configuration for developer notifications - `email` string, email — Email address to receive notifications - `events` NotificationEvent[] — List of events to subscribe to - `owner_org_id` string, required — Organization ID of the app owner - `internal` boolean — Flag to indicate if the app is built by epilot. - `pricing` object — Pricing information for the app - `pricing_type` 'FREE' | 'SUBSCRIPTION' | 'USAGE_BASED' | 'ONE_TIME' | 'CUSTOM' | 'UNKNOWN' - `billing_frequency` 'MONTHLY' | 'QUARTERLY' | 'YEARLY' | 'CUSTOM' — How often the subscription is billed - `configuration_audit` object — Audit information for the app - `created_at` string — Timestamp of the creation - `created_by` string — User ID of the creator - `updated_at` string — Timestamp of the last update - `updated_by` string — User ID of the last updater - `components` BaseComponent[], required - union - object - `id` string, required — Unique identifier for the component - `name` object — Name of the component - `en` string, nullable — English translation - `de` string, required — German translation - `description` object — Description of the component - `en` string, nullable — English translation - `de` string, required — German translation - `options` Options[] — List of options for the app component - `key` string, required — Unique identifier for this configuration option - `label` string — Human-readable label for the configuration option - `required` boolean — Flag to indicate if this option is required - `description` string — Detailed description of what this configuration option does - `value` string — The configured value for this option. Is only present when the component is installed. - `type` 'text' | 'number' | 'boolean' | 'secret', required - `component_type` 'CUSTOM_JOURNEY_BLOCK', required - `configuration` JourneyBlockConfig, required - `component_url` string, required — URL of the web component object - `component_tag` string, required — Custom element tag for the component - `component_args` JourneyBlockComponentArgs[] — Arguments to pass to the component - union - … - `component_size` number — Size of the bundle in bytes - `component_mapping` object — Define data which is mapped to entity mapping ui blocks - object - `id` string, required — Unique identifier for the component - `name` object — Name of the component - `en` string, nullable — English translation - `de` string, required — German translation - `description` object — Description of the component - `en` string, nullable — English translation - `de` string, required — German translation - `options` Options[] — List of options for the app component - `key` string, required — Unique identifier for this configuration option - `label` string — Human-readable label for the configuration option - `required` boolean — Flag to indicate if this option is required - `description` string — Detailed description of what this configuration option does - `value` string — The configured value for this option. Is only present when the component is installed. - `type` 'text' | 'number' | 'boolean' | 'secret', required - `component_type` 'PORTAL_EXTENSION', required - `origin` 'END_CUSTOMER_PORTAL' | 'INSTALLER_PORTAL' - `configuration` PortalExtensionConfig, required - `id` string - `hooks` object[] - `id` string - `type` string - `name` TranslatedString - … - `interval` string[] - `auth` PortalAuth - … - `call` object - … - `links` object[] - `id` string - `type` string - `name` TranslatedString - … - `description` TranslatedString - … - `condition` string - `auth` PortalAuth - … - `redirect` object - … - object - `id` string, required — Unique identifier for the component - `name` object — Name of the component - `en` string, nullable — English translation - `de` string, required — German translation - `description` object — Description of the component - `en` string, nullable — English translation - `de` string, required — German translation - `options` Options[] — List of options for the app component - `key` string, required — Unique identifier for this configuration option - `label` string — Human-readable label for the configuration option - `required` boolean — Flag to indicate if this option is required - `description` string — Detailed description of what this configuration option does - `value` string — The configured value for this option. Is only present when the component is installed. - `type` 'text' | 'number' | 'boolean' | 'secret', required - `component_type` 'CUSTOM_FLOW_ACTION', required - `configuration` CustomFlowConfig, required - `name` string — Name of the custom action - `description` string — Description of the custom action - `type` 'external_integration', required - `external_integration_settings` object - `url` string — URL to call - `headers` object - `auth_token_ref` string — SSM Reference to the auth token to use for the request - `public` boolean — Flag to indicate if the app is public. - `pending` boolean — Flag to indicate if the app is pending for verification - `version` string, required — Version of the app that is installed - `is_beta` boolean — Flag to indicate if the app is in beta. - `deprecated_at` string — Timestamp when the app version is deprecated - `changelog` string — Changelog for the app version - `review_status` 'approved' | 'rejected' | 'pending' — Status of the review process - `role` Role - `id` string — Name of the role - `grants` object[] — Required grants for the app in order to call APIs for the installing tenant - `action` string, required — The action the app can perform - `resource` string — The resource the app can access - `version_audit` object, required - `created_at` string — Timestamp of the creation - `created_by` string — User ID of the creator - `updated_at` string — Timestamp of the last update - `updated_by` string — User ID of the last updater - `versioned_at` string — Timestamp of the last version update - `versioned_by` string — User ID of the user who last updated the app ## Other responses - `404` — App configuration not found ## Changes - **2025-05-22** `2ab2aaf08d93` — 1 breaking, 1 warning, 2 info - added `#/components/schemas/CustomFlowActionComponent` to the `allOf[#/components/schemas/ConfigurationVersion]/components/items/allOf[subschema #2]/` response property `oneOf` list for the response status `200` - added the new `number` enum value to the `allOf[#/components/schemas/ConfigurationVersion]/components/items/allOf[subschema #2]/oneOf[#/components/schemas/JourneyBlockComponent]/configuration/component_mapping/additionalProperties/` response property for the response status `200` - added the optional property `allOf[#/components/schemas/ConfigurationVersion]/role` to the response with the `200` status - added `CUSTOM_FLOW_ACTION` discriminator mapping keys to the `allOf[#/components/schemas/ConfigurationVersion]/components/items/allOf[subschema #2]/` response property for the response status `200` - **2025-04-30** `96130e8314f3` — 1 breaking, 16 warning, 4 info - the response's body type changed from `object` to no type for status `200` - removed the optional property `access_level` from the response with the `200` status - removed the optional property `app_id` from the response with the `200` status - removed the optional property `author` from the response with the `200` status - …17 more - **2025-01-29** `8b8dde19dac7` — 1 info - endpoint added [Change history](https://skmtc.dev/epilot/apis/app-api/changes/v1/app-configurations/:appId/get.md) --- [API](https://skmtc.dev/epilot/apis/app-api.md) · [All operations](https://skmtc.dev/epilot/apis/app-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/epilot/app-api/revisions/2ab2aaf08d93/schema)