---
title: "Read Controlled Vocabulary Term Translation"
method: GET
path: "/vocab/terms/{cvtid}/translations/{locale}"
tags: ["Vocabularies"]
---

# Read Controlled Vocabulary Term Translation

`GET /vocab/terms/{cvtid}/translations/{locale}`

## Request

- Base URL: `https://apibeta.familysearch.org/platform`
- URL: `https://apibeta.familysearch.org/platform/vocab/terms/{cvtid}/translations/{locale}`
- Auth: HTTP bearer

Read a controlled vocabulary term translation.  The vocabulary term may be localized into many languages, but the term remains the same. Only one translation allowed per language.

## Path parameters

- `cvtid` string, required
- `locale` string, required

## Headers

- `Accept` 'application/x-fs-v1+json' | 'application/json', required

## Response `200`

The term translation is available.

- VocabTranslation: A vocabulary translation.
  - `id` string: A local, context-specific id for the data.
  - `lang` string
  - `text` string
  - `extensionElement` object
  - `links` Link[]: The list of hypermedia links. Links are not specified by GEDCOM X core, but as extension elements by GEDCOM X RS.
    - `href` string: The target URI of the link.
    - `template` string: A URI template per RFC 6570, used to link to a range of URIs, such as for the purpose of linking to a query.
    - `type` string: Metadata about the available media type(s) of the resource being linked to. The value of the "type" attribute is as defined by the HTTP specification, RFC 2616, Section 3.7. Note that this attribute can be considered an "Update Control (CU)" per Amundsen, M. (2011). Hypermedia APIs with HTML5 and Node. O'Reilly.
    - `accept` string: Metadata about the available media type(s) of the resource being linked to update (i.e. change the state of) the resource being linked to. The value of the "accept" attribute is as defined by the HTTP specification, RFC 2616, Section 3.7. Note that this attribute can be considered an "Read Control (CR)" per Amundsen, M. (2011). Hypermedia APIs with HTML5 and Node. O'Reilly.
    - `allow` string: Metadata about the allowable methods that can be used to transition to the resource being linked. The value of the "allow" attribute is as defined by the HTTP specification, RFC 2616, Section 14.7. Note that this attribute can be considered an "Method Control (CM)" per Amundsen, M. (2011). Hypermedia APIs with HTML5 and Node. O'Reilly.
    - `hreflang` string: The language of the resource being linked to. Note that this attribute can be considered an "Update Control (CU)" per Amundsen, M. (2011). Hypermedia APIs with HTML5 and Node. O'Reilly.
    - `title` string: Human-readable information about the link.
    - `count` integer: The number of elements in the page, if this link refers to a page of resources.
    - `offset` integer: The index of the offset of the page, if this link refers to a page of resources.
    - `results` integer: The total number of results in the page to which this links, if this link refers to a page of resources.

## Other responses

- `404`: The term or the localized term translation does not exist.

---

[API](https://skmtc.dev/familysearch/apis/standards-endpoints.md) - [All operations](https://skmtc.dev/familysearch/apis/standards-endpoints/llms.txt) - [OpenAPI document](https://skmtc.dev/familysearch/apis/standards-endpoints/revisions/bfeea6bf67e2?raw)