Skip to main content

Using Judge.me API

Updated this week

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

  • Base URL: https://judge.me/api/v1

  • Example endpoint: https://judge.me/api/v1/widgets/product_review

API credentials

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

To find shop_domain and api_token:

  • From your Judge.me admin, go to General settings > Integrations.

  • 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.

Common use cases


Create new reviews via API


Schedule review requests via API

  • Method: POST

  • Endpoint: https://judge.me/api/orders/send_manual_review_request

  • Parameters:

Param Name

Required

Param Description

api_token

yes

The token Judge.me provides. Please ask support@judge.me for the token

reviewer_name

yes

name of the recipient

reviewer_email

yes

email of the recipient

shopify_product_id

partially required

Shopify ID of the purchased product (either shopify_product_id or product_handle is required)

product_handle

partially required

handle of the purchased product (either shopify_product_id or product_handle is required)

fulfilled_at

yes

(dd/mm/yyyy) date when the order was fulfilled. E.g. 04/05/2015 for May the 4th 2015

quantity

no

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

processed_at

no

(dd/mm/yyyy) date for the request to be sent, 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


Considerations

  • Review replies are not included in API responses: The Judge.me API currently returns review content and related metadata, but does not include replies to reviews.

  • 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.

Did this answer your question?