Start a new export

  • Updated on Feb 28, 2026
  • Published on Feb 16, 2026
  • 17 minute(s) read
Prev Next
Post
/v2/Project/Export

Request Body Parameters:

  • entity (string) - Specifies the type of entity for which the export will be executed. For example, use "Project" to export content at the project level.

  • version_id (array of string) - List of unique version IDs where the export will be executed. Set to null to include all available workspaces or versions.

  • selected_languages (array of LanguageMeta) - List of languages to include in the export. Each object should define a specific language configuration.

    • code (string) - Language code (e.g., "en", "fr"). ISO language code for the selected language.
    • id (string) - Unique identifier of the language within the workspace.
    • version_id (string) - ID of the version associated with the selected language.

  • selected_categories (array of CategoryMeta) - List of categories to include in the export. Each item should follow the structure of a category and its metadata.

    • language_id (string) - ID of the language to which the category belongs. Set to null to include categories from all languages.
    • id (string) - Unique identifier of the category selected for export.

  • exclude_media_files (boolean) - Set to true to exclude all media files (images, attachments) from the export. Useful for generating lightweight exports.

  • filter_by_article_modified_at (object) - Used to apply a time-based filter on articles. Only articles modified within the date range will be included.

    • after (string/date-time) - Filters articles modified after this date (ISO 8601 format). Example: "2025-06-13T14:30:00Z"
    • before (string/date-time) - Filters articles modified before this date (ISO 8601 format). Example: "2025-06-13T14:30:00Z"

  • export_type (integer) - Specifies the format for the export.

    • 0 - JSON export (default) - generates .zip with structured JSON metadata and content files
    • 1 - HTML (offline documentation) - generates static HTML site packaged in .zip

Response (200 Success):

  • id (string) - The unique ID of the export request. Use this ID to fetch or track export details in subsequent API calls.
  • status (string) - The current status of the export request. Helps determine the progress or result of the export operation.

Notes:

  • For Category entity: Use selectedCategories to specify which categories to export (includes child categories and articles)
  • selectedLanguages filters which language versions to include in the export
  • Leave selectedLanguages and selectedCategories as empty arrays to export all available content
Security
API Key: api_token
Header parameter nameapi_token

The API token used for authenticating the request. This must be passed as a header parameter. To generate an API token, go to Settings > Knowledge base portal > API tokens. This token must correspond to a valid workspace and permission level.

Body parameters

Filter to export Full/Part of the documentation

Export - Complete Project

To export the complete project, set Entity as 'Project'. All versions, languages, and categories will be automatically included. VersionId, SelectedLanguages, and SelectedCategories will be populated automatically.

{
  "entity": "Project",
  "version_id": [],
  "selected_languages": null,
  "selected_categories": null,
  "exclude_media_files": true,
  "filter_by_article_modified_at": null,
  "export_type": 0
}
Export - One or more project versions (all languages and categories)

To export one or more project versions with all languages and categories, set Entity as 'Version' and provide VersionId array. All languages and categories for the specified versions will be automatically included. Use /projectversions API to get version IDs.

{
  "entity": "Version",
  "version_id": [
    "6558-7607-4594-ac82-e9b56aa8ab4",
    "de558-7607-4594-ac82-e9b5bdfve34"
  ],
  "selected_languages": null,
  "selected_categories": null,
  "exclude_media_files": true,
  "filter_by_article_modified_at": null,
  "export_type": 0
}
Export - Specific versions with selected languages

To export specific versions with selected languages, set Entity as 'Version' and provide both VersionId and SelectedLanguages. Categories for the specified versions and languages will be automatically included. If SelectedLanguages is not provided, all languages for the versions will be included.

{
  "entity": "Version",
  "version_id": [
    "6558-7607-4594-ac82-e9b56aa8ab4",
    "de558-7607-4594-ac82-e9b5bdfve34"
  ],
  "selected_languages": [
    {
      "id": "de558-7607-4594-c2ds-e9b5bdfve34",
      "code": "en",
      "version_id": "6558-7607-4594-ac82-e9b56aa8ab4"
    },
    {
      "id": "8558-7607-4594-rt17-e9b56aa8ab4",
      "code": "fr",
      "version_id": "de558-7607-4594-ac82-e9b5bdfve34"
    }
  ],
  "selected_categories": null,
  "exclude_media_files": true,
  "filter_by_article_modified_at": {
    "after": "2024-06-13T14:30:00Z",
    "before": "2024-06-13T14:30:00Z"
  },
  "export_type": 0
}
Export - Specific categories

To export specific categories, set Entity as 'Category' and provide SelectedCategories with Id, LanguageId, and VersionId for each category. VersionId array and SelectedLanguages will be automatically derived from the provided categories.

{
  "entity": "Category",
  "version_id": null,
  "selected_languages": null,
  "selected_categories": [
    {
      "id": "Q58df-7607-4594-ac82-e9b5bdfe1h9",
      "language_id": "lang-id-1",
      "version_id": "6558-7607-4594-ac82-e9b56aa8ab4"
    },
    {
      "id": "Q58df-7607-4594-ac82-e9b5bdfe1h9",
      "language_id": "lang-id-2",
      "version_id": "de558-7607-4594-ac82-e9b5bdfve34"
    }
  ],
  "exclude_media_files": true,
  "filter_by_article_modified_at": {
    "after": "2024-06-13T14:30:00Z",
    "before": "2024-06-13T14:30:00Z"
  },
  "export_type": 0
}
Expand All
object
entity
string | null

Entity type to export. Allowed values: "Project", "Version", "Category"

ExampleVersion
version_id
Array of string | null

Array of version IDs to export. Required when Entity is "Version". Use empty array [] for "Project" entity.

Example[ "695782c0-a0a3-4664-9bfd-0197d26379ee" ]
string
selected_languages
Array of object (LanguageMeta) | null

Optional list of languages to include in the export. Leave empty or null to export all languages.

object
id
string | null

The unique identifier of the language version

Examplea1b2c3d4-e5f6-7890-abcd-ef1234567890
code
string | null

Language code (e.g., "en" for English, "es" for Spanish, "fr" for French, "de" for German)

Exampleen
version_id
string | null
selected_categories
Array of object (CategoryMeta) | null

List of categories to include in the export. Required when Entity is "Category". Leave empty or null for "Project" or "Version" entities to export all categories.

object
id
string | null

The unique identifier of the category

Exampleb2c3d4e5-f6a7-8901-bcde-f12345678901
language_id
string | null

The language ID for the category content. Specifies which language version of the category to export.

Examplea1b2c3d4-e5f6-7890-abcd-ef1234567890
version_id
string | null
exclude_media_files
boolean

Set to true to exclude media files (images, attachments) from the export, reducing file size. Default is false.

Examplefalse
filter_by_article_modified_at
object | null

Optional date range filter to export only articles modified within the specified period.

after
string (date-time) | null

Filter the articles which are all modified after the given date

before
string (date-time) | null

Filter the articles which are all modified before the given date

export_type
integer (int32)

Export format type. 0 = JSON format (default), 1 = HTML (Offline Documentation).

Valid values[ 0, 1 ]
Example0
Export - Complete Project

To export the complete project, set Entity as 'Project'. All versions, languages, and categories will be automatically included. VersionId, SelectedLanguages, and SelectedCategories will be populated automatically.

{
  "entity": "Project",
  "version_id": [],
  "selected_languages": null,
  "selected_categories": null,
  "exclude_media_files": true,
  "filter_by_article_modified_at": null,
  "export_type": 0
}
Export - One or more project versions (all languages and categories)

To export one or more project versions with all languages and categories, set Entity as 'Version' and provide VersionId array. All languages and categories for the specified versions will be automatically included. Use /projectversions API to get version IDs.

{
  "entity": "Version",
  "version_id": [
    "6558-7607-4594-ac82-e9b56aa8ab4",
    "de558-7607-4594-ac82-e9b5bdfve34"
  ],
  "selected_languages": null,
  "selected_categories": null,
  "exclude_media_files": true,
  "filter_by_article_modified_at": null,
  "export_type": 0
}
Export - Specific versions with selected languages

To export specific versions with selected languages, set Entity as 'Version' and provide both VersionId and SelectedLanguages. Categories for the specified versions and languages will be automatically included. If SelectedLanguages is not provided, all languages for the versions will be included.

{
  "entity": "Version",
  "version_id": [
    "6558-7607-4594-ac82-e9b56aa8ab4",
    "de558-7607-4594-ac82-e9b5bdfve34"
  ],
  "selected_languages": [
    {
      "id": "de558-7607-4594-c2ds-e9b5bdfve34",
      "code": "en",
      "version_id": "6558-7607-4594-ac82-e9b56aa8ab4"
    },
    {
      "id": "8558-7607-4594-rt17-e9b56aa8ab4",
      "code": "fr",
      "version_id": "de558-7607-4594-ac82-e9b5bdfve34"
    }
  ],
  "selected_categories": null,
  "exclude_media_files": true,
  "filter_by_article_modified_at": {
    "after": "2024-06-13T14:30:00Z",
    "before": "2024-06-13T14:30:00Z"
  },
  "export_type": 0
}
Export - Specific categories

To export specific categories, set Entity as 'Category' and provide SelectedCategories with Id, LanguageId, and VersionId for each category. VersionId array and SelectedLanguages will be automatically derived from the provided categories.

{
  "entity": "Category",
  "version_id": null,
  "selected_languages": null,
  "selected_categories": [
    {
      "id": "Q58df-7607-4594-ac82-e9b5bdfe1h9",
      "language_id": "lang-id-1",
      "version_id": "6558-7607-4594-ac82-e9b56aa8ab4"
    },
    {
      "id": "Q58df-7607-4594-ac82-e9b5bdfe1h9",
      "language_id": "lang-id-2",
      "version_id": "de558-7607-4594-ac82-e9b5bdfve34"
    }
  ],
  "exclude_media_files": true,
  "filter_by_article_modified_at": {
    "after": "2024-06-13T14:30:00Z",
    "before": "2024-06-13T14:30:00Z"
  },
  "export_type": 0
}
Expand All
object
entity
string | null

Entity type to export. Allowed values: "Project", "Version", "Category"

ExampleVersion
version_id
Array of string | null

Array of version IDs to export. Required when Entity is "Version". Use empty array [] for "Project" entity.

Example[ "695782c0-a0a3-4664-9bfd-0197d26379ee" ]
string
selected_languages
Array of object (LanguageMeta) | null

Optional list of languages to include in the export. Leave empty or null to export all languages.

object
id
string | null

The unique identifier of the language version

Examplea1b2c3d4-e5f6-7890-abcd-ef1234567890
code
string | null

Language code (e.g., "en" for English, "es" for Spanish, "fr" for French, "de" for German)

Exampleen
version_id
string | null
selected_categories
Array of object (CategoryMeta) | null

List of categories to include in the export. Required when Entity is "Category". Leave empty or null for "Project" or "Version" entities to export all categories.

object
id
string | null

The unique identifier of the category

Exampleb2c3d4e5-f6a7-8901-bcde-f12345678901
language_id
string | null

The language ID for the category content. Specifies which language version of the category to export.

Examplea1b2c3d4-e5f6-7890-abcd-ef1234567890
version_id
string | null
exclude_media_files
boolean

Set to true to exclude media files (images, attachments) from the export, reducing file size. Default is false.

Examplefalse
filter_by_article_modified_at
object | null

Optional date range filter to export only articles modified within the specified period.

after
string (date-time) | null

Filter the articles which are all modified after the given date

before
string (date-time) | null

Filter the articles which are all modified before the given date

export_type
integer (int32)

Export format type. 0 = JSON format (default), 1 = HTML (Offline Documentation).

Valid values[ 0, 1 ]
Example0
Export - Complete Project

To export the complete project, set Entity as 'Project'. All versions, languages, and categories will be automatically included. VersionId, SelectedLanguages, and SelectedCategories will be populated automatically.

{
  "entity": "Project",
  "version_id": [],
  "selected_languages": null,
  "selected_categories": null,
  "exclude_media_files": true,
  "filter_by_article_modified_at": null,
  "export_type": 0
}
Export - One or more project versions (all languages and categories)

To export one or more project versions with all languages and categories, set Entity as 'Version' and provide VersionId array. All languages and categories for the specified versions will be automatically included. Use /projectversions API to get version IDs.

{
  "entity": "Version",
  "version_id": [
    "6558-7607-4594-ac82-e9b56aa8ab4",
    "de558-7607-4594-ac82-e9b5bdfve34"
  ],
  "selected_languages": null,
  "selected_categories": null,
  "exclude_media_files": true,
  "filter_by_article_modified_at": null,
  "export_type": 0
}
Export - Specific versions with selected languages

To export specific versions with selected languages, set Entity as 'Version' and provide both VersionId and SelectedLanguages. Categories for the specified versions and languages will be automatically included. If SelectedLanguages is not provided, all languages for the versions will be included.

{
  "entity": "Version",
  "version_id": [
    "6558-7607-4594-ac82-e9b56aa8ab4",
    "de558-7607-4594-ac82-e9b5bdfve34"
  ],
  "selected_languages": [
    {
      "id": "de558-7607-4594-c2ds-e9b5bdfve34",
      "code": "en",
      "version_id": "6558-7607-4594-ac82-e9b56aa8ab4"
    },
    {
      "id": "8558-7607-4594-rt17-e9b56aa8ab4",
      "code": "fr",
      "version_id": "de558-7607-4594-ac82-e9b5bdfve34"
    }
  ],
  "selected_categories": null,
  "exclude_media_files": true,
  "filter_by_article_modified_at": {
    "after": "2024-06-13T14:30:00Z",
    "before": "2024-06-13T14:30:00Z"
  },
  "export_type": 0
}
Export - Specific categories

To export specific categories, set Entity as 'Category' and provide SelectedCategories with Id, LanguageId, and VersionId for each category. VersionId array and SelectedLanguages will be automatically derived from the provided categories.

{
  "entity": "Category",
  "version_id": null,
  "selected_languages": null,
  "selected_categories": [
    {
      "id": "Q58df-7607-4594-ac82-e9b5bdfe1h9",
      "language_id": "lang-id-1",
      "version_id": "6558-7607-4594-ac82-e9b56aa8ab4"
    },
    {
      "id": "Q58df-7607-4594-ac82-e9b5bdfe1h9",
      "language_id": "lang-id-2",
      "version_id": "de558-7607-4594-ac82-e9b5bdfve34"
    }
  ],
  "exclude_media_files": true,
  "filter_by_article_modified_at": {
    "after": "2024-06-13T14:30:00Z",
    "before": "2024-06-13T14:30:00Z"
  },
  "export_type": 0
}
Expand All
object
entity
string | null

Entity type to export. Allowed values: "Project", "Version", "Category"

ExampleVersion
version_id
Array of string | null

Array of version IDs to export. Required when Entity is "Version". Use empty array [] for "Project" entity.

Example[ "695782c0-a0a3-4664-9bfd-0197d26379ee" ]
string
selected_languages
Array of object (LanguageMeta) | null

Optional list of languages to include in the export. Leave empty or null to export all languages.

object
id
string | null

The unique identifier of the language version

Examplea1b2c3d4-e5f6-7890-abcd-ef1234567890
code
string | null

Language code (e.g., "en" for English, "es" for Spanish, "fr" for French, "de" for German)

Exampleen
version_id
string | null
selected_categories
Array of object (CategoryMeta) | null

List of categories to include in the export. Required when Entity is "Category". Leave empty or null for "Project" or "Version" entities to export all categories.

object
id
string | null

The unique identifier of the category

Exampleb2c3d4e5-f6a7-8901-bcde-f12345678901
language_id
string | null

The language ID for the category content. Specifies which language version of the category to export.

Examplea1b2c3d4-e5f6-7890-abcd-ef1234567890
version_id
string | null
exclude_media_files
boolean

Set to true to exclude media files (images, attachments) from the export, reducing file size. Default is false.

Examplefalse
filter_by_article_modified_at
object | null

Optional date range filter to export only articles modified within the specified period.

after
string (date-time) | null

Filter the articles which are all modified after the given date

before
string (date-time) | null

Filter the articles which are all modified before the given date

export_type
integer (int32)

Export format type. 0 = JSON format (default), 1 = HTML (Offline Documentation).

Valid values[ 0, 1 ]
Example0
Export - Complete Project

To export the complete project, set Entity as 'Project'. All versions, languages, and categories will be automatically included. VersionId, SelectedLanguages, and SelectedCategories will be populated automatically.

{
  "entity": "Project",
  "version_id": [],
  "selected_languages": null,
  "selected_categories": null,
  "exclude_media_files": true,
  "filter_by_article_modified_at": null,
  "export_type": 0
}
Export - One or more project versions (all languages and categories)

To export one or more project versions with all languages and categories, set Entity as 'Version' and provide VersionId array. All languages and categories for the specified versions will be automatically included. Use /projectversions API to get version IDs.

{
  "entity": "Version",
  "version_id": [
    "6558-7607-4594-ac82-e9b56aa8ab4",
    "de558-7607-4594-ac82-e9b5bdfve34"
  ],
  "selected_languages": null,
  "selected_categories": null,
  "exclude_media_files": true,
  "filter_by_article_modified_at": null,
  "export_type": 0
}
Export - Specific versions with selected languages

To export specific versions with selected languages, set Entity as 'Version' and provide both VersionId and SelectedLanguages. Categories for the specified versions and languages will be automatically included. If SelectedLanguages is not provided, all languages for the versions will be included.

{
  "entity": "Version",
  "version_id": [
    "6558-7607-4594-ac82-e9b56aa8ab4",
    "de558-7607-4594-ac82-e9b5bdfve34"
  ],
  "selected_languages": [
    {
      "id": "de558-7607-4594-c2ds-e9b5bdfve34",
      "code": "en",
      "version_id": "6558-7607-4594-ac82-e9b56aa8ab4"
    },
    {
      "id": "8558-7607-4594-rt17-e9b56aa8ab4",
      "code": "fr",
      "version_id": "de558-7607-4594-ac82-e9b5bdfve34"
    }
  ],
  "selected_categories": null,
  "exclude_media_files": true,
  "filter_by_article_modified_at": {
    "after": "2024-06-13T14:30:00Z",
    "before": "2024-06-13T14:30:00Z"
  },
  "export_type": 0
}
Export - Specific categories

To export specific categories, set Entity as 'Category' and provide SelectedCategories with Id, LanguageId, and VersionId for each category. VersionId array and SelectedLanguages will be automatically derived from the provided categories.

{
  "entity": "Category",
  "version_id": null,
  "selected_languages": null,
  "selected_categories": [
    {
      "id": "Q58df-7607-4594-ac82-e9b5bdfe1h9",
      "language_id": "lang-id-1",
      "version_id": "6558-7607-4594-ac82-e9b56aa8ab4"
    },
    {
      "id": "Q58df-7607-4594-ac82-e9b5bdfe1h9",
      "language_id": "lang-id-2",
      "version_id": "de558-7607-4594-ac82-e9b5bdfve34"
    }
  ],
  "exclude_media_files": true,
  "filter_by_article_modified_at": {
    "after": "2024-06-13T14:30:00Z",
    "before": "2024-06-13T14:30:00Z"
  },
  "export_type": 0
}
Expand All
object
entity
string | null

Entity type to export. Allowed values: "Project", "Version", "Category"

ExampleVersion
version_id
Array of string | null

Array of version IDs to export. Required when Entity is "Version". Use empty array [] for "Project" entity.

Example[ "695782c0-a0a3-4664-9bfd-0197d26379ee" ]
string
selected_languages
Array of object (LanguageMeta) | null

Optional list of languages to include in the export. Leave empty or null to export all languages.

object
id
string | null

The unique identifier of the language version

Examplea1b2c3d4-e5f6-7890-abcd-ef1234567890
code
string | null

Language code (e.g., "en" for English, "es" for Spanish, "fr" for French, "de" for German)

Exampleen
version_id
string | null
selected_categories
Array of object (CategoryMeta) | null

List of categories to include in the export. Required when Entity is "Category". Leave empty or null for "Project" or "Version" entities to export all categories.

object
id
string | null

The unique identifier of the category

Exampleb2c3d4e5-f6a7-8901-bcde-f12345678901
language_id
string | null

The language ID for the category content. Specifies which language version of the category to export.

Examplea1b2c3d4-e5f6-7890-abcd-ef1234567890
version_id
string | null
exclude_media_files
boolean

Set to true to exclude media files (images, attachments) from the export, reducing file size. Default is false.

Examplefalse
filter_by_article_modified_at
object | null

Optional date range filter to export only articles modified within the specified period.

after
string (date-time) | null

Filter the articles which are all modified after the given date

before
string (date-time) | null

Filter the articles which are all modified before the given date

export_type
integer (int32)

Export format type. 0 = JSON format (default), 1 = HTML (Offline Documentation).

Valid values[ 0, 1 ]
Example0
Responses
200

Export task created successfully

Export Documentation - 200 Status response.

The below example shows the status response for export documentation. Here the export for a new documentation will be triggered.

{
  "id": "69c2a0ee-bbac-4563-921c-08efef575b64",
  "status": "Initiated",
  "extension_data": null,
  "success": true,
  "errors": [],
  "warnings": [],
  "information": []
}
Expand All
object
id
string | null

The ID of the export request. Use this ID to get export details

status
string | null

Current status of the export

ExampleInitiated
extension_data
object | null

Extension data for customer API response

success
boolean

Indicates the status of the API response. A value of true signifies that the request was successfully processed, while false indicates a failure or error occurred.

errors
Array of object (BaseError) | null

A list of errors encountered during the API request. Each error object provides details about the problem, including an error code and a message explaining the issue. This field is populated when the request fails or encounters issues.

object
extension_data
object | null

This is the Extension data object

stack_trace
string | null

A technical trace showing where the error occurred within the system. Intended for backend debugging.

description
string | null

A clear message explaining what caused the error. This helps quickly understand what went wrong.

error_code
string | null

A short, predefined code that identifies the type of error. Useful for logging the error or raising a support request.

custom_data
object | null

Any structured metadata for the error object.

property*
warnings
Array of object (BaseWarning) | null

A list of warnings generated during the API request. These are non-critical issues or recommendations that might affect the request but won't stop it from processing. Each warning object provides a message to inform the user of potential problems.

object
extension_data
object | null

Extension Data for customer Api warning

description
string | null

A plain message that describes the warning and helps understand what should be reviewed.

warning_code
string | null

A short, predefined code that uniquely identifies the warning type.

information
Array of object (BaseInformation) | null

Contains additional non-critical information relevant to the request or response. This field provides extra details that might assist in understanding the context of the API response but is not essential for processing.

object
extension_data
object | null

Extension data for customer Api response information

description
string | null

A plain message offering helpful context about the response, such as confirmation of fallback logic or skipped operations.

400

Invalid request - check entity type, versionId, or other parameters

Export Documentation - 400 Status response invalid language code.

The below example shows the error status response says invalid language code.

{
  "extension_data": null,
  "success": false,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "The LanguageCode field is required",
      "error_code": "400",
      "custom_data": null
    }
  ],
  "warnings": [],
  "information": []
}
Export Documentation - 400 Status response for reaching export documentation limit.

The below example shows the error status that you had reached the limit for the day.

{
  "extension_data": null,
  "success": false,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "Export API request limit(2) is reached for the day.",
      "error_code": "400",
      "custom_data": null
    }
  ],
  "warnings": [],
  "information": []
}
Export Documentation - 400 Status response for invalid entity field.

The below example shows the error status that the entity field should not be empty or invalid. Entity options are - 1.Project 2.Version , 3.Category , 4.Article

{
  "extension_data": null,
  "success": false,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "The Entity field is required.",
      "error_code": "400",
      "custom_data": null
    }
  ],
  "warnings": [],
  "information": []
}
Expand All
object
extension_data
object | null

Extension data for customer API response

success
boolean

Indicates the status of the API response. A value of true signifies that the request was successfully processed, while false indicates a failure or error occurred.

errors
Array of object (BaseError) | null

A list of errors encountered during the API request. Each error object provides details about the problem, including an error code and a message explaining the issue. This field is populated when the request fails or encounters issues.

object
extension_data
object | null

This is the Extension data object

stack_trace
string | null

A technical trace showing where the error occurred within the system. Intended for backend debugging.

description
string | null

A clear message explaining what caused the error. This helps quickly understand what went wrong.

error_code
string | null

A short, predefined code that identifies the type of error. Useful for logging the error or raising a support request.

custom_data
object | null

Any structured metadata for the error object.

property*
warnings
Array of object (BaseWarning) | null

A list of warnings generated during the API request. These are non-critical issues or recommendations that might affect the request but won't stop it from processing. Each warning object provides a message to inform the user of potential problems.

object
extension_data
object | null

Extension Data for customer Api warning

description
string | null

A plain message that describes the warning and helps understand what should be reviewed.

warning_code
string | null

A short, predefined code that uniquely identifies the warning type.

information
Array of object (BaseInformation) | null

Contains additional non-critical information relevant to the request or response. This field provides extra details that might assist in understanding the context of the API response but is not essential for processing.

object
extension_data
object | null

Extension data for customer Api response information

description
string | null

A plain message offering helpful context about the response, such as confirmation of fallback logic or skipped operations.