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

# Get translation keys with metadata

`GET /api/v1/translation-keys`

## Request

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

Get translation keys for a project.

All parameters are optional.

Parameters are used for filtering translations by given values, and they are case sensitive and exact match.

Default page size is 100 and maximum page size is 2500. Page size can be changed by `size` parameter.

Default page is 0. Page can be changed by `page` parameter.

## Query parameters

- `key` string
- `namespace` string
- `sort` 'last_seen_at' | 'modified_at' | 'created_at' | 'deprecated_at'
- `page` integer
- `size` integer

## Response `200`

OK

- PagedTranslationKeysV2RestResponse
  - `msg` string: Message
  - `status` integer: Status code
  - `data` TranslationKeyResponseV2[]: Response data
    - `key` string
    - `namespace` string
    - `description` string
    - `codeDescription` string
    - `createdAt` string
    - `createdSource` string
    - `lastSeenAt` string
    - `lastSeenSource` string
    - `charactersLimit` integer
    - `deprecated` boolean
    - `attributes` object
  - `pageDetails` PageDetails
    - `totalElements` integer
    - `totalPages` integer
    - `currentPage` integer
    - `hasNext` boolean
    - `first` boolean
    - `last` boolean

## 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`: 2 info
  - added the optional property `data/items/attributes` to the response with the `200` status
  - added the optional property `data/items/deprecated` to the response with the `200` status
- **2025-11-12** `0329534cd557`: 1 warning, 17 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 new optional `query` request parameter `sort`
  - …14 more
- **2025-04-19** `5475c7163be9`: 8 info
  - added the optional property `code` to the response with the `400` status
  - added the optional property `code` to the response with the `402` status
  - added the optional property `code` to the response with the `403` status
  - added the optional property `code` to the response with the `404` status
  - …4 more
- **2023-11-30** `18bfbf87af44`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/simplelocalize/apis/simplelocalize-api/changes/api/v1/translation-keys/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)