---
title: "Get a paged response of Global String Definitions."
method: GET
path: "/api/v2/StringDefinitions"
tags: ["StringDefinitions"]
---

# Get a paged response of Global String Definitions.

`GET /api/v2/StringDefinitions`

## Request

- Base URL: `https://secure.agco-ats.com`
- URL: `https://secure.agco-ats.com/api/v2/StringDefinitions`
- Auth: none declared

No Documentation Found.

## Query parameters

- `limit` integer
- `modifiedAfterTimestamp` string
- `includeTranslations` boolean
- `stringText` string
- `descriptionText` string
- `useFullText` boolean
- `includeDeletedLanguages` boolean
- `languageIds` string
- `stringIds` string
- `matchingTranslationsOnly` boolean

## Response `200`

OK

- APIIPagedResponseGlobalResourcesSharedModelsStringDefinition
  - `Entities` GlobalResourcesSharedModelsStringDefinition[]
    - `Id` string: The identifier for the string. Read Only.
    - `DescriptionForTranslator` string, required: The description of the string to be translated.
    - `ParameterCount` integer: The number of parameters expected for the string.
    - `Timestamp` string, byte: A value indicating the last modification of this string. Read Only.
    - `DoNotTranslate` boolean: True if the string should not be translated. False by default.
    - `Translations` GlobalResourcesSharedModelsStringTranslation[]: Translations for the string.
      - `StringValue` string, required: The translated string
      - `State` 'Original' | 'Requested' | 'Processing' | 'Processed' | 'Validated' | 'Invalidated' | 'RequestPending' | 'CreatePending': The state of the translation
      - `Timestamp` string, byte: A value indicating the last modification of this translation. Read Only.
      - `AuthorId` integer: The id of the user to last edit thie translation
      - `StringId` string: The id of the string that is translated
      - `LanguageId` integer: The id of the language of the translation
  - `Metadata` APIPagedResponseMetadata: Metadata for the paged response
    - `TotalCount` integer, required: The total number of entities matching the request.
    - `Limit` integer, required: The number of entities this paged response is limited to.
    - `Offset` integer, required: The number of entities prior to this page of items.

## Other responses

- `default`: API Error Response

## Changes

- **2022-09-25** `64b7a32ab769`: 2 info
  - added the new optional `query` request parameter `matchingTranslationsOnly`
  - added the new optional `query` request parameter `stringIds`

[Operation history](https://skmtc.dev/agco-ats/apis/agco-ats-api/changes/api/v2/StringDefinitions/get.md)

---

[API](https://skmtc.dev/agco-ats/apis/agco-ats-api.md) - [All operations](https://skmtc.dev/agco-ats/apis/agco-ats-api/llms.txt) - [OpenAPI document](https://skmtc.dev/agco-ats/apis/agco-ats-api/revisions/8b416443df5c?raw)