Back to endpoints

Get a keyword

GET api/V3/{language}/keywords/{id}

?partner={partner}

Returns an individual keyword by id, with the option to specify a partner name

Request Information

URI Parameters

PARAMETERS
language (string)

Language in which the localizable values should be returned. Part of base url. Value is either 'fr' or 'en'

Required
id (integer)

Keyword id

Required
partner (string)

Partner name. Default value is null

Optional

Body Parameters

None.

Response Information

Resource Description

PARAMETERS
Id (integer)

Resource id

Name (string)

Resource name

ParentVerticalId (integer)

Id of parent for verticals that are children, such as yoga id is to hatha yoga id

PartnerId (integer)

Id of the partner in the Amilia database

Response Formats

CODE SAMPLE JSON
{
  "Id": 0,
  "Name": "Skiing",
  "ParentVerticalId": 842
}