Skip to content
NimlesNimlesNimles Docs

Get a review

GET
/api/tenant/{tenantId}/Reviews/{id}
curl --request GET \
  --url https://api.nimles.com/pim/api/tenant/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/Reviews/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid
tenantId
required
string format: uuid

Your tenant id.

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
fields
object
key
additional properties
string
data
object
fields
object
key
additional properties
object
value
required
nullable
valueType
string
nullable
accessibility
string
nullable
id
string format: uuid
relations
Array<object>
nullable
object
fields
object
key
additional properties
object
value
required
nullable
valueType
string
nullable
accessibility
string
nullable
id
string format: uuid
name
string
nullable
entityId
required
string format: uuid
entityType
required
string
>= 1 characters
relationType
required
string
>= 1 characters
tenantId
string format: uuid
nullable
resourceGroupId
string format: uuid
nullable
creatorId
string format: uuid
nullable
createdDate
string format: date-time
nullable
version
integer format: int32
nullable
lastModified
string format: date-time
nullable
organizationId
string format: uuid
nullable
vehicleId
string format: uuid
publishedDate
string format: date-time
nullable
reviewType
required
string
nullable
status
required
string
nullable
uniqueName
string
nullable
tags
Array<string>
nullable
targetId
string format: uuid
listImage
string format: uuid
imageIds
Array<string>
nullable
reviewGroupIds
Array<string>
nullable
publisherId
string format: uuid
nullable
condition
string
nullable
color
string
nullable
pros
Array<object>
nullable
object
fields
object
key
additional properties
object
value
required
nullable
valueType
string
nullable
accessibility
string
nullable
id
string format: uuid
value
string
nullable
valueLocalized
object
key
additional properties
string
cons
Array<object>
nullable
object
fields
object
key
additional properties
object
value
required
nullable
valueType
string
nullable
accessibility
string
nullable
id
string format: uuid
value
string
nullable
valueLocalized
object
key
additional properties
string
sizeSystem
string
nullable
targetType
string
nullable
maxEnergyEfficiencyClass
string
nullable
listPrice
number format: double
nullable
purchasePrice
number format: double
nullable
title
string
nullable
titleLocalized
object
key
additional properties
string
longTitle
string
nullable
longTitleLocalized
object
key
additional properties
string
additionalName
string
nullable
additionalNameLocalized
object
key
additional properties
string
summary
string
nullable
summaryLocalized
object
key
additional properties
string
description
string
nullable
descriptionLocalized
object
key
additional properties
string
duration
integer format: int64
nullable
sections
Array<object>
nullable
object
title
string
nullable
text
string
nullable
imageId
string format: uuid
nullable
price
number format: double
nullable
scores
Array<object>
nullable
object
name
string
nullable
value
number format: double
comment
object
fields
object
key
additional properties
object
value
required
nullable
valueType
string
nullable
accessibility
string
nullable
id
string format: uuid
value
string
nullable
valueLocalized
object
key
additional properties
string
score
object
name
string
nullable
value
number format: double
comment
object
fields
object
key
additional properties
object
value
required
nullable
valueType
string
nullable
accessibility
string
nullable
id
string format: uuid
value
string
nullable
valueLocalized
object
key
additional properties
string
vatRate
integer format: int32
nullable
isGrossPrice
boolean
startDate
string format: date-time
nullable
endDate
string format: date-time
nullable

Example generated

{
  "data": {
    "fields": {
      "additionalProperty": {
        "value": "example",
        "valueType": "example"
      }
    },
    "accessibility": "example",
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "relations": [
      {
        "fields": {
          "additionalProperty": {
            "value": "example",
            "valueType": "example"
          }
        },
        "accessibility": "example",
        "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "name": "example",
        "entityId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "entityType": "example",
        "relationType": "example"
      }
    ],
    "tenantId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "resourceGroupId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "creatorId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "createdDate": "2026-04-15T12:00:00Z",
    "version": 1,
    "lastModified": "2026-04-15T12:00:00Z",
    "organizationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "vehicleId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "publishedDate": "2026-04-15T12:00:00Z",
    "reviewType": "example",
    "status": "example",
    "uniqueName": "example",
    "tags": [
      "example"
    ],
    "targetId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "listImage": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "imageIds": [
      "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
    ],
    "reviewGroupIds": [
      "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
    ],
    "publisherId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "condition": "example",
    "color": "example",
    "pros": [
      {
        "fields": {
          "additionalProperty": {
            "value": "example",
            "valueType": "example"
          }
        },
        "accessibility": "example",
        "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "value": "example",
        "valueLocalized": {
          "additionalProperty": "example"
        }
      }
    ],
    "cons": [
      {
        "fields": {
          "additionalProperty": {
            "value": "example",
            "valueType": "example"
          }
        },
        "accessibility": "example",
        "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "value": "example",
        "valueLocalized": {
          "additionalProperty": "example"
        }
      }
    ],
    "sizeSystem": "example",
    "targetType": "example",
    "maxEnergyEfficiencyClass": "example",
    "listPrice": 1,
    "purchasePrice": 1,
    "title": "example",
    "titleLocalized": {
      "additionalProperty": "example"
    },
    "longTitle": "example",
    "longTitleLocalized": {
      "additionalProperty": "example"
    },
    "additionalName": "example",
    "additionalNameLocalized": {
      "additionalProperty": "example"
    },
    "summary": "example",
    "summaryLocalized": {
      "additionalProperty": "example"
    },
    "description": "example",
    "descriptionLocalized": {
      "additionalProperty": "example"
    },
    "duration": 1,
    "sections": [
      {
        "title": "example",
        "text": "example",
        "imageId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
      }
    ],
    "price": 1,
    "scores": [
      {
        "name": "example",
        "value": 1,
        "comment": {
          "fields": {
            "additionalProperty": {
              "value": "example",
              "valueType": "example"
            }
          },
          "accessibility": "example",
          "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
          "value": "example",
          "valueLocalized": {
            "additionalProperty": "example"
          }
        }
      }
    ],
    "score": {
      "name": "example",
      "value": 1,
      "comment": {
        "fields": {
          "additionalProperty": {
            "value": "example",
            "valueType": "example"
          }
        },
        "accessibility": "example",
        "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "value": "example",
        "valueLocalized": {
          "additionalProperty": "example"
        }
      }
    },
    "vatRate": 1,
    "isGrossPrice": true,
    "startDate": "2026-04-15T12:00:00Z",
    "endDate": "2026-04-15T12:00:00Z"
  }
}

401

Section titled “401”

Unauthorized: no bearer token, or one that is expired or not for this API.

403

Section titled “403”

Forbidden: the caller holds no role that allows this action at this scope. The body is empty, or a problem whose detail names the action.

Media typeapplication/json

An RFC 9457 problem.

object
detail
string
nullable
instance
string
nullable
status
integer format: int32
nullable
title
string
nullable
type
string
nullable
key
additional properties

Example generated

{
  "detail": "example",
  "instance": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

404

Section titled “404”

Not found: no such item in the tenant.

Media typeapplication/problem+json

An RFC 9457 problem.

object
detail
string
nullable
instance
string
nullable
status
integer format: int32
nullable
title
string
nullable
type
string
nullable
key
additional properties

Example generated

{
  "detail": "example",
  "instance": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}