---
title: "Get translation key details"
method: GET
path: "/api/v1/translation-keys/details"
tags: ["Translation keys"]
---

# Get translation key details

`GET /api/v1/translation-keys/details`

## Request

- Base URL: `https://api.simplelocalize.io`
- URL: `https://api.simplelocalize.io/api/v1/translation-keys/details`
- Auth: API key in header `X-SimpleLocalize-Token`
- TypeScript: <https://skmtc.dev/simplelocalize/apis/simplelocalize-api/docs/api/v1/translation-keys/details/get.ts> (a function with typed inputs; its response is checked against the schema)

Get translation key details for a project

`key` is a required field, and it cannot be null or empty. The endpoint throws an error if `key` is null or empty.

`namespace` is an optional field, and it can be null or empty. Null and empty values are ignored.

If `namespace` is not provided, then an empty namespace is used.



Please not that we may return additional fields in the future.

## Query parameters

- `key` string, required
- `namespace` string

## Response `200`

OK

- object
  - `msg` string
  - `status` integer
  - `data` TranslationKeyDetailsResponseV2
    - `key` string
    - `namespace` string
    - `description` string
    - `codeDescription` string
    - `createdAt` string
    - `createdSource` string
    - `lastSeenAt` string
    - `lastSeenSource` string
    - `charactersLimit` integer
    - `tags` Tag[]
      - `name` string
      - `color` string
    - `deprecated` boolean
    - `attributes` object
    - `screenshotUrl` string

## Other responses

- `400`: Bad Request
- `402`: Payment Required
- `403`: Forbidden
- `404`: Not Found
- `409`: Conflict
- `429`: Too Many Requests
- `500`: Internal Server Error

## Changes

- **2026-11-07** `67a25a25863a`: 3 info
  - added the optional property `data/attributes` to the response with the `200` status
  - added the optional property `data/deprecated` to the response with the `200` status
  - added the optional property `data/screenshotUrl` to the response with the `200` status
- **2025-11-12** `0329534cd557`: 1 warning, 16 info
  - deleted the `header` request parameter `X-SimpleLocalize-Token`
  - the endpoint scheme security `Project API Key` was added to the API
  - the endpoint scheme security `apiKey` was removed from the API
  - added the optional property `title` to the response with the `400` status
  - …13 more
- **2025-04-19** `5475c7163be9`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/simplelocalize/apis/simplelocalize-api/changes/api/v1/translation-keys/details/get.md)

---

[API](https://skmtc.dev/simplelocalize/apis/simplelocalize-api.md) - [All operations](https://skmtc.dev/simplelocalize/apis/simplelocalize-api/llms.txt) - [OpenAPI document](https://skmtc.dev/simplelocalize/apis/simplelocalize-api/revisions/67a25a25863a?raw)