Skip to main content

Get Category by lookup key

GET 

/categories/:lookupKey/:lookupValue

Use this endpoint to retrieve category details by lookup key. If multiple categories with the same lookup key exist, use additional filtering depending on the lookup key to uniquely identify the category (e.g. source and language for lookup key source).

Request

Path Parameters

    lookupKey stringrequired

    Lookup key. Read more about category lookup keys

    lookupValue stringrequired

    The value of the key (id or sourceId)

Query Parameters

    source string

    Optional. Used in combination with lookup key sourceId

    language string

    Optional. Default language of the category

    expands string

    Use translation when retrieving translated fields in all languages. By default, only the default language of the category will be provided. What is resource expanding?

Responses

Get Category by Id - 200

Response Headers

  • Alt-Svc

    string

  • Via

    string

  • alt-svc

    string

  • content-length

    string

  • date

    string

  • return-format

    string

  • server

    string

  • x-request-id

    string

Schema

    data

    object

    descriptions

    object[]

  • Array [

  • language string
    value string
  • ]

  • id number

    names

    object[]

  • Array [

  • language string
    value string
  • ]

  • shortDescriptions

    object[]

  • Array [

  • language string
    value string
  • ]

  • messages undefined[]
    total number
Loading...