Skip to main content

Using Judge.me API

Judge.me API lets you access your store’s review data programmatically, so you can build custom workflows, sync reviews with other platforms, or generate reports.


Technical resources

API documentation

  • The Judge.me API follows the OpenAPI specification.

  • To view the documentation, to go https://judge.me/api.

  • Original YAML file also available at that link.

Server endpoint

API credentials

To use our API, you'll need 2 credentials: shop_domain and api_token. To find them:

  1. From your Judge.me admin, go to Settings > Integrations.

  2. Click the View API tokens button on the top right.

There you'll find:

  • Your Public API Token: This public token is suitable for making GET requests to our widget API. It's designed for use in public JavaScript environments.

  • Your Private API Token: This private token grants read/write access to your data and should be exclusively used on the server-side for enhanced security.

  • Your Shop domain in myshopify.com format.


Reviews

1. Retrieve reviews

Method: GET

Parameter

Required

Description

api_token

Yes

Your Private API token

shop_domain

Yes

Your Shop domain (e.g. example.myshopify.com)

per_page

No

Number of reviews per page. Maximum: 100.

page

No

Page number

product_id

No

Internal Judge.me product ID. If the ID does not belong to your store, the response falls back to all reviews for the store

rating

No

Filter by rating (1–5)

published

No

Filter by publish status

reviewer_id

No

Filter by Judge.me internal reviewer ID

reviewer_email

No

Filter by reviewer email

Each review object includes review content and related metadata, for example:

  • pictures: An array of picture objects with URLs and hidden status.

  • has_published_pictures: Boolean — true if the review has any published pictures.

  • has_published_videos: Boolean — true if the review has any published videos.

The response does not include video URLs and replies to reviews.

2. Create reviews

Method: POST

Parameter

Required

Description

shop_domain

Yes

Your Shop domain (e.g. example.myshopify.com)

platform

Yes

One of: shopify, woocommerce, bigcommerce

name

Yes

Reviewer display name

email

Yes

Reviewer email

rating

Yes

1–5

body

Yes

Review body text

id

No

Shopify product ID (external)

title

No

Review title

reviewer_name_format

No

One of: '', last_initial, all_initials, anonymous. Default: full name.

cf_answers

No

array of { cf_question_id, value }. Answers to shop custom form questions.

picture_urls

No

URLs of review images

ip_addr

No

Reviewer IP for location

Please note:

  • Duplicate reviews when using cf_answers: If the cf_answers array is included with non-empty values in the API payload, multiple identical reviews may be created—despite sending only one request. This issue has been observed in Make.com and confirmed via Postman testing. To avoid this, omit cf_answers or leave it empty.

  • Reviews created via the Judge.me API cannot be marked as verified. It is not possible to create a verified review or update an existing review to verified status through the API.

  • Reviews created via the Judge.me API cannot be deleted.


Review requests

Add manual review requests

Method: POST

Parameter

Required

Description

api_token

Yes

Your Private API token

shop_domain

Yes

Your Shop domain (e.g. example.myshopify.com)

reviewer_name

Yes

Reviewer name

reviewer_email

Yes

Reviewer email

shopify_product_id

Yes

Shopify product ID (external)

product_handle

Yes

Product handle

fulfilled_at

Yes

When the order was fulfilled, in dd/mm/yyyy format

quantity

Yes

quantity of the purchased product, we will set to 1 by default

processed_at

Yes

When the request will be sent, in dd/mm/yyyy format

  • If blank, we will calculate using fulfilled_at plus wait date in your settings.

  • If processed_at is in the past, we will schedule a request email after 10 minutes


Products

Look up internal product ID

In our API, products have two types of IDs:

  • External ID: The Shopify product ID

  • ID: The internal Judge.me product ID

To find the external ID of the product: See Finding Product ID and Product Handle.

To find the internal ID of the product, you’ll need to use the Judge.me Product API to convert the external ID into our internal ID:

Method: GET

Parameter

Required

Description

id

Yes

Judge.me internal product ID. Use -1 to look up by external_id or handle instead.

api_token

Yes

Your Private API token

shop_domain

Yes

Your Shop domain (e.g. example.myshopify.com)

external_id

Conditional

Shopify product ID (external)

handle

Conditional

Product handle

This call will return a product object. Look for the id field inside the product object — that is the internal Judge.me product ID.

Did this answer your question?