Reviews REST API

Reviews REST API documentation and interactive testing.

For the OpenAPI Specification document use this link: https://apis.objectsgrid.com/reviews/contract

Create object

post
Authorizations
Header parameters
X-ObjectsGrid-AccessPointstring · enumRequired

EU or US depending on where your Organization Account is located

Possible values:
X-ObjectsGrid-RestApiVersionstringOptional

This header allows targeting an API version. If you want to target the latest API version set its value to 'latest' If you want to target the latest stable API version set its value to 'stable'

X-ObjectsGrid-SessionIDstringOptional

This header allows you to provide a Session ID to be traced through the request stack and returned in the response.

Body

Implements https://schema.org/Review

at_contextstring · enumOptional

Convention for '@context' JSON-LD compliance, convert in the frontend

Possible values:
at_typestring · enumOptional

Convention for '@type' JSON-LD compliance, convert in the frontend

Possible values:
idstringOptional

The Review's ID, generated

itemReviewedstringRequired

URL reference to the reviewed item

reviewAspectstringOptional
authorstringRequired

URL reference to the Author

datePublishedstring · dateRequired
urlstringOptional

URL reference to itself

Responses
201

Successfully created the object

application/json
post
POST /reviews HTTP/1.1
Host: apis.objectsgrid.com
Authorization: Bearer Bearer JWT
X-ObjectsGrid-AccessPoint: EU
Content-Type: application/json
Accept: */*
Content-Length: 640

{
  "at_context": "https://schema.org",
  "at_type": "Review",
  "id": "text",
  "name": [
    {
      "at_value": "text",
      "at_language": "text"
    }
  ],
  "itemReviewed": "text",
  "reviewAspect": "text",
  "reviewBody": [
    {
      "at_value": "text",
      "at_language": "text"
    }
  ],
  "reviewRating": {
    "at_type": "Rating",
    "ratingValue": 1,
    "worstRating": 1,
    "bestRating": 1,
    "reviewAspect": "text"
  },
  "author": "text",
  "datePublished": "2025-08-26",
  "url": "text",
  "tags": [
    {
      "name": "text",
      "val": "text"
    }
  ],
  "meta": {
    "objectVersion": 1,
    "objectType": "text",
    "namespace": "text",
    "createdAt": "2025-08-26T22:29:52.823Z",
    "createdBy": "text",
    "lastUpdatedAt": "2025-08-26T22:29:52.823Z",
    "lastUpdatedBy": "text",
    "lastUpdateCorrelationID": "text"
  }
}
{
  "at_context": "https://schema.org",
  "at_type": "Review",
  "id": "text",
  "name": [
    {
      "at_value": "text",
      "at_language": "text"
    }
  ],
  "itemReviewed": "text",
  "reviewAspect": "text",
  "reviewBody": [
    {
      "at_value": "text",
      "at_language": "text"
    }
  ],
  "reviewRating": {
    "at_type": "Rating",
    "ratingValue": 1,
    "worstRating": 1,
    "bestRating": 1,
    "reviewAspect": "text"
  },
  "author": "text",
  "datePublished": "2025-08-26",
  "url": "text",
  "tags": [
    {
      "name": "text",
      "val": "text"
    }
  ],
  "meta": {
    "objectVersion": 1,
    "objectType": "text",
    "namespace": "text",
    "createdAt": "2025-08-26T22:29:52.823Z",
    "createdBy": "text",
    "lastUpdatedAt": "2025-08-26T22:29:52.823Z",
    "lastUpdatedBy": "text",
    "lastUpdateCorrelationID": "text"
  }
}

Retrieve Object

get
Authorizations
Path parameters
idstringRequired

ID of the object to retrieve

Query parameters
langstringOptional

BCP 47 language code

Example: fr, de, de-AT, cy-GB
Header parameters
X-ObjectsGrid-AccessPointstring · enumRequired

EU or US depending on where your Organization Account is located

Possible values:
X-ObjectsGrid-RestApiVersionstringOptional

This header allows targeting an API version. If you want to target the latest API version set its value to 'latest' If you want to target the latest stable API version set its value to 'stable'

X-ObjectsGrid-SessionIDstringOptional

This header allows you to provide a Session ID to be traced through the request stack and returned in the response.

Responses
200

Successfully retrieved the object

application/json
get
GET /reviews/{id} HTTP/1.1
Host: apis.objectsgrid.com
Authorization: Bearer Bearer JWT
X-ObjectsGrid-AccessPoint: EU
Accept: */*

{
  "at_context": "https://schema.org",
  "at_type": "Review",
  "id": "text",
  "name": [
    {
      "at_value": "text",
      "at_language": "text"
    }
  ],
  "itemReviewed": "text",
  "reviewAspect": "text",
  "reviewBody": [
    {
      "at_value": "text",
      "at_language": "text"
    }
  ],
  "reviewRating": {
    "at_type": "Rating",
    "ratingValue": 1,
    "worstRating": 1,
    "bestRating": 1,
    "reviewAspect": "text"
  },
  "author": "text",
  "datePublished": "2025-08-26",
  "url": "text",
  "tags": [
    {
      "name": "text",
      "val": "text"
    }
  ],
  "meta": {
    "objectVersion": 1,
    "objectType": "text",
    "namespace": "text",
    "createdAt": "2025-08-26T22:29:52.823Z",
    "createdBy": "text",
    "lastUpdatedAt": "2025-08-26T22:29:52.823Z",
    "lastUpdatedBy": "text",
    "lastUpdateCorrelationID": "text"
  }
}

Update Object

put
Authorizations
Path parameters
idstringRequired

ID of the object to update

Header parameters
X-ObjectsGrid-AccessPointstring · enumRequired

EU or US depending on where your Organization Account is located

Possible values:
X-ObjectsGrid-RestApiVersionstringOptional

This header allows targeting an API version. If you want to target the latest API version set its value to 'latest' If you want to target the latest stable API version set its value to 'stable'

X-ObjectsGrid-SessionIDstringOptional

This header allows you to provide a Session ID to be traced through the request stack and returned in the response.

Body

Implements https://schema.org/Review

at_contextstring · enumOptional

Convention for '@context' JSON-LD compliance, convert in the frontend

Possible values:
at_typestring · enumOptional

Convention for '@type' JSON-LD compliance, convert in the frontend

Possible values:
idstringOptional

The Review's ID, generated

itemReviewedstringRequired

URL reference to the reviewed item

reviewAspectstringOptional
authorstringRequired

URL reference to the Author

datePublishedstring · dateRequired
urlstringOptional

URL reference to itself

Responses
200

Successfully updated the object

application/json
put
PUT /reviews/{id} HTTP/1.1
Host: apis.objectsgrid.com
Authorization: Bearer Bearer JWT
X-ObjectsGrid-AccessPoint: EU
Content-Type: application/json
Accept: */*
Content-Length: 640

{
  "at_context": "https://schema.org",
  "at_type": "Review",
  "id": "text",
  "name": [
    {
      "at_value": "text",
      "at_language": "text"
    }
  ],
  "itemReviewed": "text",
  "reviewAspect": "text",
  "reviewBody": [
    {
      "at_value": "text",
      "at_language": "text"
    }
  ],
  "reviewRating": {
    "at_type": "Rating",
    "ratingValue": 1,
    "worstRating": 1,
    "bestRating": 1,
    "reviewAspect": "text"
  },
  "author": "text",
  "datePublished": "2025-08-26",
  "url": "text",
  "tags": [
    {
      "name": "text",
      "val": "text"
    }
  ],
  "meta": {
    "objectVersion": 1,
    "objectType": "text",
    "namespace": "text",
    "createdAt": "2025-08-26T22:29:52.823Z",
    "createdBy": "text",
    "lastUpdatedAt": "2025-08-26T22:29:52.823Z",
    "lastUpdatedBy": "text",
    "lastUpdateCorrelationID": "text"
  }
}
{
  "at_context": "https://schema.org",
  "at_type": "Review",
  "id": "text",
  "name": [
    {
      "at_value": "text",
      "at_language": "text"
    }
  ],
  "itemReviewed": "text",
  "reviewAspect": "text",
  "reviewBody": [
    {
      "at_value": "text",
      "at_language": "text"
    }
  ],
  "reviewRating": {
    "at_type": "Rating",
    "ratingValue": 1,
    "worstRating": 1,
    "bestRating": 1,
    "reviewAspect": "text"
  },
  "author": "text",
  "datePublished": "2025-08-26",
  "url": "text",
  "tags": [
    {
      "name": "text",
      "val": "text"
    }
  ],
  "meta": {
    "objectVersion": 1,
    "objectType": "text",
    "namespace": "text",
    "createdAt": "2025-08-26T22:29:52.823Z",
    "createdBy": "text",
    "lastUpdatedAt": "2025-08-26T22:29:52.823Z",
    "lastUpdatedBy": "text",
    "lastUpdateCorrelationID": "text"
  }
}

Patch Object

patch
Authorizations
Path parameters
idstringRequired

ID of the object to update

Header parameters
X-ObjectsGrid-AccessPointstring · enumRequired

EU or US depending on where your Organization Account is located

Possible values:
X-ObjectsGrid-RestApiVersionstringOptional

This header allows targeting an API version. If you want to target the latest API version set its value to 'latest' If you want to target the latest stable API version set its value to 'stable'

X-ObjectsGrid-SessionIDstringOptional

This header allows you to provide a Session ID to be traced through the request stack and returned in the response.

Body

Implements https://schema.org/Review

at_contextstring · enumOptional

Convention for '@context' JSON-LD compliance, convert in the frontend

Possible values:
at_typestring · enumOptional

Convention for '@type' JSON-LD compliance, convert in the frontend

Possible values:
idstringOptional

The Review's ID, generated

itemReviewedstringRequired

URL reference to the reviewed item

reviewAspectstringOptional
authorstringRequired

URL reference to the Author

datePublishedstring · dateRequired
urlstringOptional

URL reference to itself

Responses
200

Successfully patched the object

application/json
patch
PATCH /reviews/{id} HTTP/1.1
Host: apis.objectsgrid.com
Authorization: Bearer Bearer JWT
X-ObjectsGrid-AccessPoint: EU
Content-Type: application/json
Accept: */*
Content-Length: 640

{
  "at_context": "https://schema.org",
  "at_type": "Review",
  "id": "text",
  "name": [
    {
      "at_value": "text",
      "at_language": "text"
    }
  ],
  "itemReviewed": "text",
  "reviewAspect": "text",
  "reviewBody": [
    {
      "at_value": "text",
      "at_language": "text"
    }
  ],
  "reviewRating": {
    "at_type": "Rating",
    "ratingValue": 1,
    "worstRating": 1,
    "bestRating": 1,
    "reviewAspect": "text"
  },
  "author": "text",
  "datePublished": "2025-08-26",
  "url": "text",
  "tags": [
    {
      "name": "text",
      "val": "text"
    }
  ],
  "meta": {
    "objectVersion": 1,
    "objectType": "text",
    "namespace": "text",
    "createdAt": "2025-08-26T22:29:52.823Z",
    "createdBy": "text",
    "lastUpdatedAt": "2025-08-26T22:29:52.823Z",
    "lastUpdatedBy": "text",
    "lastUpdateCorrelationID": "text"
  }
}
{
  "at_context": "https://schema.org",
  "at_type": "Review",
  "id": "text",
  "name": [
    {
      "at_value": "text",
      "at_language": "text"
    }
  ],
  "itemReviewed": "text",
  "reviewAspect": "text",
  "reviewBody": [
    {
      "at_value": "text",
      "at_language": "text"
    }
  ],
  "reviewRating": {
    "at_type": "Rating",
    "ratingValue": 1,
    "worstRating": 1,
    "bestRating": 1,
    "reviewAspect": "text"
  },
  "author": "text",
  "datePublished": "2025-08-26",
  "url": "text",
  "tags": [
    {
      "name": "text",
      "val": "text"
    }
  ],
  "meta": {
    "objectVersion": 1,
    "objectType": "text",
    "namespace": "text",
    "createdAt": "2025-08-26T22:29:52.823Z",
    "createdBy": "text",
    "lastUpdatedAt": "2025-08-26T22:29:52.823Z",
    "lastUpdatedBy": "text",
    "lastUpdateCorrelationID": "text"
  }
}

Delete Object

delete
Authorizations
Path parameters
idstringRequired

ID of the object to delete

Header parameters
X-ObjectsGrid-AccessPointstring · enumRequired

EU or US depending on where your Organization Account is located

Possible values:
X-ObjectsGrid-RestApiVersionstringOptional

This header allows targeting an API version. If you want to target the latest API version set its value to 'latest' If you want to target the latest stable API version set its value to 'stable'

X-ObjectsGrid-SessionIDstringOptional

This header allows you to provide a Session ID to be traced through the request stack and returned in the response.

Responses
200

Successfully deleted the object

delete
DELETE /reviews/{id} HTTP/1.1
Host: apis.objectsgrid.com
Authorization: Bearer Bearer JWT
X-ObjectsGrid-AccessPoint: EU
Accept: */*

No content

List objects

get

This operation supports Elastic Search Query DSL query format

Authorizations
Query parameters
langstringOptional

BCP 47 language code

Example: fr, de, de-AT, cy-GB
querystringOptional

Elastic Search Query DSL.

Example: { "query": { "match_all": {} } }
fromintegerOptional

Defines the starting record number for retrieval.

sizeintegerOptional

Defines the number of records to retrieve.

Header parameters
X-ObjectsGrid-AccessPointstring · enumRequired

EU or US depending on where your Organization Account is located

Possible values:
X-ObjectsGrid-RestApiVersionstringOptional

This header allows targeting an API version. If you want to target the latest API version set its value to 'latest' If you want to target the latest stable API version set its value to 'stable'

X-ObjectsGrid-SessionIDstringOptional

This header allows you to provide a Session ID to be traced through the request stack and returned in the response.

Responses
200

Successfully listed the objects

application/json
get
GET /reviews HTTP/1.1
Host: apis.objectsgrid.com
Authorization: Bearer Bearer JWT
X-ObjectsGrid-AccessPoint: EU
Accept: */*

[
  {
    "at_context": "https://schema.org",
    "at_type": "Review",
    "id": "text",
    "name": [
      {
        "at_value": "text",
        "at_language": "text"
      }
    ],
    "itemReviewed": "text",
    "reviewAspect": "text",
    "reviewBody": [
      {
        "at_value": "text",
        "at_language": "text"
      }
    ],
    "reviewRating": {
      "at_type": "Rating",
      "ratingValue": 1,
      "worstRating": 1,
      "bestRating": 1,
      "reviewAspect": "text"
    },
    "author": "text",
    "datePublished": "2025-08-26",
    "url": "text",
    "tags": [
      {
        "name": "text",
        "val": "text"
      }
    ],
    "meta": {
      "objectVersion": 1,
      "objectType": "text",
      "namespace": "text",
      "createdAt": "2025-08-26T22:29:52.823Z",
      "createdBy": "text",
      "lastUpdatedAt": "2025-08-26T22:29:52.823Z",
      "lastUpdatedBy": "text",
      "lastUpdateCorrelationID": "text"
    }
  }
]
PreviousReview ObjectNextOffer Object

Last updated

Was this helpful?