List all translations

Retrieves a paginated list of all translations for the application with optional filtering by parent type and field type

GET/api/v1/{team_slug}/{app_slug}/translations
API
Management
Updated
Apr 26, 2026

management-api:GET:/api/v1/{team_slug}/{app_slug}/translations

Retrieves a paginated list of all translations for the application with optional filtering by parent type and field type

API ownership

  • API family: Management API
  • Best for: Trusted back-office workflows that create, update, organize, or delete merchant-owned data.
  • Do not use from: Browser-only storefront code or public clients.
  • Guide route: /apis/management/latest

The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation.

Operation

  • Method: GET
  • Path: /api/v1/\{team_slug\}/\{app_slug\}/translations
  • Summary: List all translations
  • Description: Retrieves a paginated list of all translations for the application with optional filtering by parent type and field type
  • OpenAPI contract: management-api
  • Operation ID: Not documented in the OpenAPI contract.

Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID.

Parameters6 parameters
NameInRequiredTypeDescription
app_slugpathYesstringApp slug
team_slugpathYesstringTeam slug
pagequeryNointegerPage number (default is 1)
per-pagequeryNointegerAmount of products per page. Minimum 0 and max 100 (default is 20)
parent-typequeryNostringFilter on parent type. Can be one of product product_bundle product_variant image attribute attribute_value category tag collection file bundle_group
field-typequeryNostringFilter on field type. Can be one of name value description alt title copyright slug meta_title meta_description html_description short_description html_short_description key
Request bodyNo documented body

Not documented in the OpenAPI contract.

Responses4 statuses
StatusDescriptionContent
200Translationsapplication/json (object)
400Invalid request (e.g. bad UUID, validation error)application/json (object)
401Unauthorized accessapplication/json (object)
500Internal server errorapplication/json (object)

200 - object

Paginated Translation List

PropertyTypeRequiredDetails
dataobject[]No-
successbooleanNo-
totalintegerNo-
total_pagesintegerNo-
Translation
PropertyTypeRequiredDetails
field_typeenum("name", "value", "description", "alt", "title", "type", "copyright", "slug", "meta_title", "meta_description", "html_description", "short_description", "html_short_description", "key")Yes-
idstringNo-
language_codestringYes-
parent_refstringYes-
parent_typeenum("product", "product_bundle", "product_variant", "channel_content", "image", "attribute", "attribute_value", "category", "tag", "collection", "file", "bundle_group", "video", "brand", "variant_group")Yes-
translationstringYes-

Generated example (synthetic):

{
  "data": [
    {
      "field_type": "name",
      "id": "string",
      "language_code": "string",
      "parent_ref": "string",
      "parent_type": "product",
      "translation": "string"
    }
  ],
  "success": false,
  "total": 0,
  "total_pages": 0
}

400 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

401 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

500 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

Contract identity

Use these fields to confirm you are implementing the intended endpoint contract.

  • API family: Management API
  • Method: GET
  • Path: /api/v1/\{team_slug\}/\{app_slug\}/translations
  • Operation ID: Not documented in the OpenAPI contract.
  • OpenAPI tag: Translations
  • OpenAPI summary: List all translations

List all translations

# List all translations Retrieves a paginated list of all translations for the application with optional filtering by parent type and field type
GET /api/v1/{team_slug}/{app_slug}/translations
Purpose

Retrieves a paginated list of all translations for the application with optional filtering by parent type and field type

Required inputs

app_slug path team_slug path

Primary response

200 ยท Translations

Operation key

management-api:GET:/api/v1/{team_slug}/{app_slug}/translations

## API ownership - API family: Management API - Best for: Trusted back-office workflows that create, update, organize, or delete merchant-owned data. - Do not use from: Browser-only storefront code or public clients. - Guide route: [/apis/management/latest](/apis/management/latest) The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation. ## Operation - Method: `GET` - Path: `/api/v1/{team_slug}/{app_slug}/translations` - Summary: List all translations - Description: Retrieves a paginated list of all translations for the application with optional filtering by parent type and field type - OpenAPI contract: management-api - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `management-api:GET:/api/v1/{team_slug}/{app_slug}/translations` Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID. ## Parameters | Name | In | Required | Type | Description | | --- | --- | --- | --- | --- | | app_slug | path | Yes | string | App slug | | team_slug | path | Yes | string | Team slug | | page | query | No | integer | Page number (default is 1) | | per-page | query | No | integer | Amount of products per page. Minimum 0 and max 100 (default is 20) | | parent-type | query | No | string | Filter on parent type. Can be one of product product_bundle product_variant image attribute attribute_value category tag collection file bundle_group | | field-type | query | No | string | Filter on field type. Can be one of name value description alt title copyright slug meta_title meta_description html_description short_description html_short_description key | ## Request body Not documented in the OpenAPI contract. ## Responses | Status | Description | Content | | --- | --- | --- | | 200 | Translations | application/json (object) | | 400 | Invalid request (e.g. bad UUID, validation error) | application/json (object) | | 401 | Unauthorized access | application/json (object) | | 500 | Internal server error | application/json (object) | ### 200 - object #### Paginated Translation List | Property | Type | Required | Details | | --- | --- | --- | --- | | `data` | object[] | No | - | | `success` | boolean | No | - | | `total` | integer | No | - | | `total_pages` | integer | No | - | ##### Translation | Property | Type | Required | Details | | --- | --- | --- | --- | | `field_type` | enum("name", "value", "description", "alt", "title", "type", "copyright", "slug", "meta_title", "meta_description", "html_description", "short_description", "html_short_description", "key") | Yes | - | | `id` | string | No | - | | `language_code` | string | Yes | - | | `parent_ref` | string | Yes | - | | `parent_type` | enum("product", "product_bundle", "product_variant", "channel_content", "image", "attribute", "attribute_value", "category", "tag", "collection", "file", "bundle_group", "video", "brand", "variant_group") | Yes | - | | `translation` | string | Yes | - | **Generated example (synthetic):** ```json { "data": [ { "field_type": "name", "id": "string", "language_code": "string", "parent_ref": "string", "parent_type": "product", "translation": "string" } ], "success": false, "total": 0, "total_pages": 0 } ``` ### 400 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ### 401 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ### 500 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ## Contract identity Use these fields to confirm you are implementing the intended endpoint contract. - API family: Management API - Method: `GET` - Path: `/api/v1/{team_slug}/{app_slug}/translations` - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `management-api:GET:/api/v1/{team_slug}/{app_slug}/translations` - OpenAPI tag: Translations - OpenAPI summary: List all translations