--- title: "Read Vocabulary Concept V2" method: GET path: "/vocab/concepts/{cvcid}" tags: ["Vocabularies"] --- # Read Vocabulary Concept V2 `GET /vocab/concepts/{cvcid}` ## Request - Base URL: `https://apibeta.familysearch.org/platform` - URL: `https://apibeta.familysearch.org/platform/vocab/concepts/{cvcid}` - Auth: HTTP bearer Read a vocabulary concept in V2 format. Returns a `VocabConcepts` wrapper containing a list of controlled vocabulary terms with their definitions and attributes for the specified concept id. The scope of the terms returned can be limited by using the `type` query parameter. Multiple types may be requested by supplying a comma-separated list of types. All terms will be returned if this query parameter is omitted. ### A Selection of Commonly Referenced Term Types: | Type | Description | |------|-------------| | OFFICIAL | Official term for the concept (There is at most one, and there should *always* be one associated with a concept.) | | OFFICIAL_PLURAL | The plural form of the official term (There is at most one, but is optional for a concept. May be the same text as OFFICIAL.) | | ABBREVIATION | Abbreviation (Zero or more for the same concept.) | | ALTERNATE | Variant name for the term (Zero or more for the same concept.) | | CODE | Code representation of the term (Optionally supported by a concept.) | ### V1 Response Format (Deprecated) **Note:** This endpoint also supports V1 response formats via the following Accept headers: - `application/ld+json` (JSON-LD V1) - `application/x-fs-v1+json` (FamilySearch Platform V1 JSON) - `application/json` (Generic JSON V1) - `application/rdf+xml` (RDF/XML V1) - `application/x-fs-v1+xml` (FamilySearch Platform V1 XML) - `application/xml` (Generic XML V1) The V1 format returns a single `VocabConcept` object and does **not support** the `descendancy` parameter. **V1 is considered deprecated.** We strongly recommend that new applications use the V2 format (specified above with `application/ld-v2+json` or `application/x-fs-v2+json` Accept headers) which provides enhanced functionality including descendancy support. ## Path parameters - `cvcid` string, required ## Query parameters - `type` string ## Headers - `Accept` 'application/ld-v2+json' | 'application/x-fs-v2+json', required ## Response `200` The concept is available. - VocabConcepts: A list of vocabulary concepts. - `vocabConcepts` VocabConcept[]: The list of vocabulary concepts. - `id` string: A local, context-specific id for the data. - `description` string: The vocabulary concept description. - `note` string: The vocabulary concept note. - `gedcomxUri` string: The Gedcomx URI associated with the concept. - `vocabTerms` VocabTerm[]: The terms associated with the concept. - `id` string: A local, context-specific id for the data. - `typeUri` string: The vocabulary term type. - `sublistUri` string: The URI of the sublist this vocabulary term is associated with. - `sublistPosition` integer: The position of this vocabulary term within it's associated sublist. - `values` TextValue[]: The values of the vocabulary term. - `lang` string: The language of the text value. See http://www.w3.org/International/articles/language-tags/ - `value` string: The text value. - `vocabConceptUri` string - `vocabConcept` 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. - `attributes` VocabConceptAttribute[]: The attributes associated with the concept. - `id` string: The vocabulary concept attribute id. - `name` string: The vocabulary concept attribute name. - `value` string: The vocabulary concept attribute value. - `definitions` TextValue[]: The definitions associated with the concept. - `lang` string: The language of the text value. See http://www.w3.org/International/articles/language-tags/ - `value` string: The text value. - `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 concept 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)