Skip to content
msMarketSDK

all endpoints

// api reference

Reviews

GET /v1/reviews

Visible reviews about a buyer or a seller

secret key only

GET /v1/reviewsrequest
curl https://api.marketsdk.com/v1/reviews \
  -H "Authorization: Bearer $MARKETSDK_KEY"
200 example response, review list
{
  "object": "list",
  "data": [
    {
      "object": "review",
      "id": "rev_034XtPDs7UJ0TXzTsdaHZa",
      "order": "string",
      "author_role": "buyer",
      "author": "string",
      "subject": "string",
      "visible": false,
      "rating": null,
      "body": null,
      "removed": false,
      "created_at": "2026-10-01T12:00:00.000Z"
    }
  ],
  "has_more": false,
  "next_cursor": null
}

parameters

Parameters
fieldtypeabout
limitinteger, in querymin 1, max 100, default 20
starting_afterstring, in queryThe next_cursor of the previous page.
subjectrequiredstring, in queryThe buyer or seller the reviews are about.

returns 200, review list

fields
Response fields
fieldtypeabout
objectrequiredone of: list
datarequiredarray of review
data[].objectrequiredone of: review
data[].idrequiredstring
data[].orderrequiredstring
data[].author_rolerequiredone of: buyer, seller
data[].authorrequiredstring
data[].subjectrequiredstring
data[].visiblerequiredbooleanFalse until both parties have reviewed or the review window has closed. Rating and body are withheld until then.
data[].ratingrequiredinteger or nullmin 1, max 5
data[].bodyrequiredstring or null
data[].removedrequiredbooleanRemoved by moderation. A removed review stops counting toward reputation.
data[].created_atrequiredtimestamp
has_morerequiredbooleanWhether another page follows.
next_cursorrequiredstring or nullPass as starting_after (or cursor for search) to get the next page.

errors

  • 400The request is not valid.
  • 401No API key, or not a valid one.
  • 429Rate limited. See Retry-After.

GET /v1/reviews/{id}

Retrieve a review

secret key only

GET /v1/reviews/{id}request
curl https://api.marketsdk.com/v1/reviews/{id} \
  -H "Authorization: Bearer $MARKETSDK_KEY"
200 example response, review
{
  "object": "review",
  "id": "rev_034XtPDs7UJ0TXzTsdaHZa",
  "order": "string",
  "author_role": "buyer",
  "author": "string",
  "subject": "string",
  "visible": false,
  "rating": null,
  "body": null,
  "removed": false,
  "created_at": "2026-10-01T12:00:00.000Z"
}

parameters

Parameters
fieldtypeabout
idrequiredstring, in path

returns 200, review

fields
Response fields
fieldtypeabout
objectrequiredone of: review
idrequiredstring
orderrequiredstring
author_rolerequiredone of: buyer, seller
authorrequiredstring
subjectrequiredstring
visiblerequiredbooleanFalse until both parties have reviewed or the review window has closed. Rating and body are withheld until then.
ratingrequiredinteger or nullmin 1, max 5
bodyrequiredstring or null
removedrequiredbooleanRemoved by moderation. A removed review stops counting toward reputation.
created_atrequiredtimestamp

errors

  • 400The request is not valid.
  • 401No API key, or not a valid one.
  • 404No object with that id in this marketplace.
  • 429Rate limited. See Retry-After.