Variants

Fetch variants

Returns a list of the variants in the workspace.

get/variants

Request

  • Base URL: https://api.dittowords.com/v2
  • URL: https://api.dittowords.com/v2/variants
  • Auth: API key in header Authorization

Response

Returns an array of variants in the workspace

idstring required

The Developer ID of the variant. Keywords 'all' and 'base' are reserved

namestring required

The name of the variant

descriptionstring required

The description provided for the variant. Empty string if no description exists

localeCodestring nullable required

The variant's locale code (for example, 'es', 'fr-ca'), or null if it is not locale-scoped. When translating, this is the authoritative target locale — do not infer the locale from the variant's name.

Example response

[
  {
    "id": "all-1",
    "name": "all",
    "description": ""
  },
  {
    "id": "french",
    "name": "French",
    "description": "French translations"
  },
  {
    "id": "spanish",
    "name": "Spanish",
    "description": ""
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.