Judge.me API

https://judge.me/api/docs
Admin
Judge.me API is a REST API that enables developers to access and manage product reviews, ratings,...
Tokens:18,548
Snippets:144
Trust Score:10
Update:15 hours ago
Show doc for...
Tokens:
Raw
### Get settings response example (200)

Source: https://judge.me/api/docs

Example response for the GET /settings endpoint, showing a settings object with keys like admin_email, autopublish, widget_star_color, and enable_review_pictures.

```json
{
  "settings": {
    "admin_email": "support@judge.me",
    "autopublish": true,
    "widget_star_color": "#339999",
    "enable_review_pictures": true
  }
}
```

--------------------------------

### Get Reviewer - Response Example

Source: https://judge.me/api/docs

Example JSON response from the GET /api/v1/reviewers/{id} endpoint. Contains reviewer details including id, email, name, phone, tags, accepts_marketing, unsubscribed_at, and external_id.

```json
{
  "reviewer": {
    "id": 111,
    "email": "john@example.com",
    "name": "John Smith",
    "phone": "+123456789",
    "tags": [
      "tag1",
      "tag2",
      "tag3"
    ],
    "accepts_marketing": true,
    "unsubscribed_at": "2020-02-20T20:20:20+00:00",
    "external_id": 999999
  }
}
```

--------------------------------

### GET /shops/info response payload

Source: https://judge.me/api/docs

Example response from the shop info endpoint, containing store details such as plan, platform, and owner information.

```json
{
  "shop": {
    "id": "111",
    "awesome": "true",
    "country": "US",
    "created_at": "2022-04-18T10:43:52+00:00",
    "currency": "USD",
    "custom_domain": "{{shop_domain}}",
    "dmarc_ok": "true",
    "domain": "{{shop_domain}}",
    "email": "john@example.com",
    "name": "Example store",
    "onboarding_progress": "skip-installation",
    "owner": "John Smith",
    "phone": "44123456789",
    "plan": "basic",
    "platform": "shopify",
    "timezone": "(GMT-05:00) America/New_York",
    "updated_at": "2023-11-23T13:50:40+00:00",
    "widget_version": "3.0"
  }
}
```

--------------------------------

### GET /oauth/authorize

Source: https://judge.me/api/docs

Starts the OAuth2 authorization flow. Redirects the user to the Judge.me authorization page where they can grant permissions to your app.

```APIDOC
## GET /oauth/authorize

### Description
Starts the OAuth2 authorization flow. Redirects the user to the Judge.me authorization page where they can grant permissions to your app.

### Method
GET

### Endpoint
https://app.judge.me/oauth/authorize

### Parameters
#### Query Parameters
- **client_id** (string) - Required - Your application's client ID.
- **redirect_uri** (string) - Required - The URI to redirect to after authorization.
- **response_type** (string) - Required - Must be `code`.
- **scope** (string) - Required - List of permissions you are asking for.
- **state** (string) - Required - A state value for CSRF protection.

### Request Example
GET https://app.judge.me/oauth/authorize?client_id=[your_client_id]&redirect_uri=[your_redirect_uri]&response_type=code&scope=[list_of_permissions_you_are_asking]&state=[state]

### Response
#### Success Response (302)
Redirects to the redirect_uri with an authorization code.

#### Response Example
Redirect to: [your_redirect_uri]?code=AUTHORIZATION_CODE&state=[state]
```

--------------------------------

### GET /widgets/all_reviews_count

Source: https://judge.me/api/docs

Returns a single total number of product and store reviews.

```APIDOC
## GET /widgets/all_reviews_count

### Description
Returns a single total number of product and store reviews.

### Method
GET

### Endpoint
https://api.judge.me/api/v1/widgets/all_reviews_count

### Authorizations
- PrivateAPIKey__ShopDomain
- PublicAPIKey__ShopDomain
- OAuthAPIKey

### Response
#### Success Response (200)
Successful operation

```

--------------------------------

### GET /settings

Source: https://judge.me/api/docs

Retrieves multiple settings values of the store in Judge.me, which can serve as conditions for your app integrations.

```APIDOC
## [GET] /settings

### Description
Get multiple settings values of the store in Judge.me, which can serve as conditions for your app integrations.

### Method
GET

### Endpoint
https://api.judge.me/api/v1/settings

### Authorizations
- PrivateAPIKey__ShopDomain
- OAuthAPIKey

### Query Parameters
- **setting_keys[]** (array of strings) - Required - Array of keys of settings. Example: setting_keys[]=admin_email&setting_keys[]=autopublish&setting_keys[]=widget_star_color&setting_keys[]=enable_review_pictures

### Response
#### Success Response (200)
- **settings** (object) - The settings object containing the requested keys.
  - **admin_email** (string) - The admin email.
  - **autopublish** (boolean) - Whether autopublish is enabled.
  - **widget_star_color** (string) - The widget star color.
  - **enable_review_pictures** (boolean) - Whether review pictures are enabled.

#### Response Example
{
  "settings": {
    "admin_email": "support@judge.me",
    "autopublish": true,
    "widget_star_color": "#339999",
    "enable_review_pictures": true
  }
}

```

--------------------------------

### Bulk Create Webhooks - Request Payload

Source: https://judge.me/api/docs

JSON payload for the POST /api/v1/webhooks/bulk_create endpoint. Requires an array of webhook objects, each with a 'key' and 'url'. The example uses key 'review/created' and a URL pointing to an example webhook endpoint.

```json
{
  "webhooks": [
    {
      "key": "review/created",
      "url": "https://example.com/webhook/example.myshopify.com/settings/updated"
    }
  ]
}
```

--------------------------------

### GET /widgets/settings

Source: https://judge.me/api/docs

Returns the widget settings of the shop in HTML format, containing a script tag and a style tag. This includes customization values such as text and color. Requires API key authorization.

```APIDOC
## [GET] /widgets/settings

### Description
Return widget settings of the shop, under HTML format, containing a `<script>` tag and a `<style>` tag. This contains values of widget customization in Judge.me such as text and color, which helps you display the widget correctly.

### Method
GET

### Endpoint
https://api.judge.me/api/v1/widgets/settings

### Authorizations
- PrivateAPIKey__ShopDomain
- PublicAPIKey__ShopDomain
- OAuthAPIKey

### Response
#### Success Response (200)
Successful operation

```

--------------------------------

### GET /widgets/all_reviews_page

Source: https://judge.me/api/docs

Retrieves the All Reviews Page, a dedicated page showcasing all product and store reviews. Supports pagination and filtering by review type.

```APIDOC
## GET /widgets/all_reviews_page

### Description
Retrieves the All Reviews Page, a dedicated page showcasing all product and store reviews. Supports pagination and filtering by review type.

### Method
GET

### Endpoint
https://api.judge.me/api/v1/widgets/all_reviews_page

### Authorizations
- PrivateAPIKey__ShopDomain
- PublicAPIKey__ShopDomain
- OAuthAPIKey

### Parameters
#### Query Parameters
- **page** (number) - Optional - For pagination. Example: page=1
- **review_type** (string) - Optional - Whether to show product reviews, or shop reviews, default to product reviews. Enum: "product-reviews", "shop-reviews". Example: review_type=product-reviews

### Response
#### Success Response (200)
Successful operation

```

--------------------------------

### Update Review Success Response

Source: https://judge.me/api/docs

Example 200 response from the PUT /reviews/{id} endpoint, indicating the action was performed successfully.

```json
{
  "message": "Action performed successful"
}
```

--------------------------------

### GET /widgets/preview_badge

Source: https://judge.me/api/docs

Retrieves the Preview Badge widget HTML, which displays average star rating and review count for a product. Specify the product by handle, external ID, or Judge.me internal ID.

```APIDOC
## GET /widgets/preview_badge

### Description
Retrieves the Preview Badge widget HTML, which displays average star rating and review count for a product. Specify the product by handle, external ID, or Judge.me internal ID.

### Method
GET

### Endpoint
https://api.judge.me/api/v1/widgets/preview_badge

### Parameters
#### Query Parameters
- **handle** (string) - Optional - Example: handle=example-product
- **external_id** (number) - Optional - External (Shopify) ID of the Product. Note: this is NOT internal Product ID of Judge.me. Example: external_id=999999
- **id** (number, internal_id) - Optional - Judge.me internal ID of the Product. Example: id=111

### Response
#### Success Response (200)
- Returns the widget HTML content.

### Authorizations
- PrivateAPIKey__ShopDomain
- PublicAPIKey__ShopDomain
- OAuthAPIKey
```

--------------------------------

### OAuth Authorization URL

Source: https://judge.me/api/docs

Start the OAuth flow by directing the user to this URL. Replace placeholders with your client ID, redirect URI, requested permissions, and state.

```http
GET https://app.judge.me/oauth/authorize?client_id=[your_client_id]&redirect_uri=[your_redirect_uri]&response_type=code&scope=[list_of_permissions_you_are_asking]&state=[state]
```

--------------------------------

### Reviews Management - Reviews

Source: https://judge.me/api/docs

Endpoints for managing reviews: index, create, update, count, and get.

```APIDOC
## Reviews Management - Reviews

### getIndex

### postCreate

### putUpdate

### getCount

### getGet
```

--------------------------------

### GET /widgets/shop_reviews_count

Source: https://judge.me/api/docs

Returns a single total number of store reviews. Requires API key authorization.

```APIDOC
## [GET] /widgets/shop_reviews_count

### Description
Return a single total number of store reviews.

### Method
GET

### Endpoint
https://api.judge.me/api/v1/widgets/shop_reviews_count

### Authorizations
- PrivateAPIKey__ShopDomain
- PublicAPIKey__ShopDomain
- OAuthAPIKey

### Response
#### Success Response (200)
Successful operation

```

--------------------------------

### GET /api/v1/reviews/count

Source: https://judge.me/api/docs

Get count of reviews for a specific product or reviewer. If product_id is not provided, returns the count of all product and store reviews of that store.

```APIDOC
## [GET] /api/v1/reviews/count

### Description
Get count of reviews for a specific product or reviewer. If product_id is not provided, returns the count of all product and store reviews of that store.

### Method
GET

### Endpoint
https://api.judge.me/api/v1/reviews/count

### Parameters
#### Query Parameters
- **reviewer_id** (number) - Optional - Judge.me internal ID of the Reviewer
- **product_id** (number) - Optional - Judge.me internal ID of the Product
- **rating** (number) - Optional - Only include reviews with this rating. Enum: 1, 2, 3, 4, 5

### Response
#### Success Response (200)
- **count** (number) - The count of reviews

```

--------------------------------

### GET /api/v1/reviews

Source: https://judge.me/api/docs

Retrieves reviews for a product or store. If product_id is not provided, returns all product and store reviews for the store. Supports pagination and filtering by reviewer, product, and rating.

```APIDOC
## GET /api/v1/reviews

### Description
Get info of reviews of a product. If `product_id` is not provided, return all product and store reviews of that store.

### Method
GET

### Endpoint
https://api.judge.me/api/v1/reviews

### Authorizations
- _PrivateAPIKey__ShopDomain_
- _OAuthAPIKey_

### Parameters
#### Query Parameters
- **per_page** (number) - Optional - For pagination. Example: per_page=10
- **page** (number) - Optional - For pagination. Example: page=1
- **reviewer_id** (number, internal_id) - Optional - Judge.me internal ID of the Reviewer. Example: reviewer_id=111
- **product_id** (number, internal_id) - Optional - Judge.me internal ID of the Product. Example: product_id=111
- **rating** (number) - Optional - Only include reviews with this rating. Enum: 1, 2, 3, 4, 5. Example: rating=5

### Response
#### Success Response (200)
Array of reviews

#### Response Example
```json
{
  "current_page": 1,
  "per_page": 10,
  "reviews": [
    {
      "id": 111,
      "title": "Raw review title. This is not sanitized yet so do not print it out as-is in frontend.",
      "body": "Raw review body. This is not sanitized yet so do not print it out as-is in frontend.",
      "rating": 5,
      "pinned": false,
      "product_external_id": 999999,
      "product_title": "Example product",
      "product_handle": "example-product",
      "reviewer": {
        "id": 111,
        "email": "john@example.com",
        "name": "John Smith",
        "phone": "+123456789",
        "tags": ["tag1", "tag2", "tag3"],
        "accepts_marketing": true,
        "unsubscribed_at": "2020-02-20T20:20:20+00:00",
        "external_id": 999999
      },
      "source": "email",
      "curated": "ok",
      "hidden": false,
      "verified": "buyer",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "ip_address": "string",
      "has_published_pictures": false,
      "has_published_videos": false,
      "pictures": [
        {
          "hidden": true,
          "urls": {
            "small": "string",
            "compact": "string",
            "huge": "string",
            "original": "string"
          }
        }
      ]
    }
  ]
}
```
```

--------------------------------

### GET /api/v1/widgets/product_review

Source: https://judge.me/api/docs

Retrieves the Product Review Widget HTML for a specified product. Use product handle, external ID, or Judge.me internal ID to identify the product. Supports pagination via page and per_page parameters.

```APIDOC
## GET /api/v1/widgets/product_review

### Description
Retrieves the Product Review Widget HTML for a specified product. Use product handle, external ID, or Judge.me internal ID to identify the product. Supports pagination via page and per_page parameters.

### Method
GET

### Endpoint
https://api.judge.me/api/v1/widgets/product_review

### Parameters
#### Query Parameters
- **handle** (string) - Optional - Example: handle=example-product
- **external_id** (number) - Optional - External (Shopify) ID of the Product. Note: this is NOT internal Product ID of Judge.me. Example: external_id=999999
- **id** (number) - Optional - Judge.me internal ID of the Product. Example: id=111
- **page** (number) - Optional - For pagination. Example: page=1
- **per_page** (number) - Optional - For pagination. Example: per_page=5

### Authorizations
- _PrivateAPIKey__ShopDomain_
- _PublicAPIKey__ShopDomain_
- _OAuthAPIKey_

### Response
#### Success Response (200)
Returns the widget HTML content.

#### Response Example
```
[HTML content of the product review widget]
```

```

--------------------------------

### Reviews Management - Webhooks

Source: https://judge.me/api/docs

Endpoints for managing webhooks: index, delete, create, get, update, and bulk create.

```APIDOC
## Reviews Management - Webhooks

### getIndex

### delDelete

### postCreate

### getGet

### putUpdate

### postBulk Create
```

--------------------------------

### General - Shops

Source: https://judge.me/api/docs

Endpoints for managing shops: get current shop's info, update current shop, and uninstall shop from Judge.me.

```APIDOC
## General - Shops

### getGet current shop's info

### putUpdate current shop

### delUninstall shop from Judge.me
```

--------------------------------

### General - Reviewers

Source: https://judge.me/api/docs

Endpoints for managing reviewers: get and update, and data request.

```APIDOC
## General - Reviewers

### getGet

### putUpdate

### postData Request
```

--------------------------------

### GET /webhooks

Source: https://judge.me/api/docs

Retrieves the list of webhooks registered for the authenticated shop. Requires authentication via Private API Key, Shop Domain, or OAuth API Key.

```APIDOC
## [GET] /webhooks

### Description
Retrieves the list of webhooks registered for the authenticated shop.

### Method
GET

### Endpoint
https://api.judge.me/api/v1/webhooks

### Authorizations
- PrivateAPIKey
- ShopDomain
- OAuthAPIKey

### Response
#### Success Response (200)
- **shop_id** (integer) - The ID of the shop.
- **shop_domain** (string) - The domain of the shop.
- **webhooks** (array) - List of webhook objects.
  - **id** (integer) - The webhook ID.
  - **failure_count** (integer) - Number of delivery failures.
  - **key** (string) - The event key (e.g., review/created).
  - **url** (string) - The registered callback URL.

#### Response Example
{
  "shop_id": 111,
  "shop_domain": "example.myshopify.com",
  "webhooks": [
    {
      "id": 111,
      "failure_count": 0,
      "key": "review/created",
      "url": "https://example.com/webhook/example.myshopify.com/settings/updated"
    }
  ]
}
```

--------------------------------

### GET /widgets/shop_reviews_rating

Source: https://judge.me/api/docs

Returns a single number representing the average rating of store reviews. Requires API key authorization.

```APIDOC
## [GET] /widgets/shop_reviews_rating

### Description
Return a single number of average rating of store reviews.

### Method
GET

### Endpoint
https://api.judge.me/api/v1/widgets/shop_reviews_rating

### Authorizations
- PrivateAPIKey__ShopDomain
- PublicAPIKey__ShopDomain
- OAuthAPIKey

### Response
#### Success Response (200)
Successful operation

```

--------------------------------

### GET /widgets/all_reviews_rating

Source: https://judge.me/api/docs

Returns a single number representing the average rating of all product reviews and store reviews. Requires API key authorization.

```APIDOC
## [GET] /widgets/all_reviews_rating

### Description
Return a single number of average rating of product reviews and store reviews.

### Method
GET

### Endpoint
https://api.judge.me/api/v1/widgets/all_reviews_rating

### Authorizations
- PrivateAPIKey__ShopDomain
- PublicAPIKey__ShopDomain
- OAuthAPIKey

### Response
#### Success Response (200)
Successful operation

```

--------------------------------

### GET /widgets/verified_badge

Source: https://judge.me/api/docs

Displays the number of verified published reviews. Stores need at least 20 verified reviews to use this widget.

```APIDOC
## GET /widgets/verified_badge

### Description
Displays the number of verified published reviews. Stores need at least 20 verified reviews to use this widget.

### Method
GET

### Endpoint
https://api.judge.me/api/v1/widgets/verified_badge

### Authorizations
- PrivateAPIKey__ShopDomain
- PublicAPIKey__ShopDomain
- OAuthAPIKey

### Response
#### Success Response (200)
Successful operation

```

--------------------------------

### GET /widgets/html_miracle

Source: https://judge.me/api/docs

Returns special HTML that helps show essential parts of widgets before the JS and CSS files are loaded. Requires authentication via Private API Key, Public API Key, or OAuth API Key.

```APIDOC
## GET /widgets/html_miracle

### Description
Returns special HTML that helps show essential parts of widgets before the JS and CSS files are loaded.

### Method
GET

### Endpoint
https://api.judge.me/api/v1/widgets/html_miracle

### Authorizations
- PrivateAPIKey__ShopDomain
- PublicAPIKey__ShopDomain
- OAuthAPIKey

### Response
#### Success Response (200)
Successful operation

```

--------------------------------

### GET /api/v1/shops/info

Source: https://judge.me/api/docs

This endpoint retrieves basic information about the current store, such as Judge.me plan, owner name, email, e-commerce platform, and more. It is useful for developing integrations targeted at specific user segments.

```APIDOC
## [GET] /api/v1/shops/info

### Description
This endpoint retrieves basic information about the current store, such as Judge.me plan, owner name, email, e-commerce platform, and more. It is useful for developing integrations targeted at specific user segments.

### Method
GET

### Endpoint
https://api.judge.me/api/v1/shops/info

### Authorizations
- PrivateAPIKey__ShopDomain
- OAuthAPIKey

### Parameters
#### Request Body
- **shop** (object) - Required - Shop information object

### Request Example
{
  "shop": {
    "id": "111",
    "awesome": "true",
    "country": "US",
    "created_at": "2022-04-18T10:43:52+00:00",
    "currency": "USD",
    "custom_domain": "{{shop_domain}}",
    "dmarc_ok": "true",
    "domain": "{{shop_domain}}",
    "email": "john@example.com",
    "name": "Example store",
    "onboarding_progress": "skip-installation",
    "owner": "John Smith",
    "phone": "44123456789",
    "plan": "basic",
    "platform": "shopify",
    "timezone": "(GMT-05:00) America/New_York",
    "updated_at": "2023-11-23T13:50:40+00:00",
    "widget_version": "3.0"
  }
}

### Response
#### Success Response (200)
Successful operation

```

--------------------------------

### GET /api/v1/webhooks/{id}

Source: https://judge.me/api/docs

Retrieves a webhook by its Judge.me internal ID. The response includes shop details and the webhook configuration.

```APIDOC
## [GET] /api/v1/webhooks/{id}

### Description
Retrieves a webhook by its Judge.me internal ID. The response includes shop details and the webhook configuration.

### Method
GET

### Endpoint
https://api.judge.me/api/v1/webhooks/{id}

### Parameters
#### Path Parameters
- **id** (number) - Required - Judge.me internal ID of the Webhook

### Authorizations
- _PrivateAPIKey__ShopDomain__OAuthAPIKey_

### Response
#### Success Response (200)
- **shop_id** (number) - The shop's ID
- **shop_domain** (string) - The shop's domain
- **webhook** (object) - The webhook details
  - **id** (number) - The webhook's ID
  - **failure_count** (number) - Number of delivery failures
  - **key** (string) - The event key that triggers the webhook
  - **url** (string) - The URL to which the webhook is sent

#### Response Example
{
  "shop_id": 111,
  "shop_domain": "example.myshopify.com",
  "webhook": {
    "id": 111,
    "failure_count": 0,
    "key": "review/created",
    "url": "https://example.com/webhook/example.myshopify.com/settings/updated"
  }
}
```

--------------------------------

### GET /widgets/featured_carousel

Source: https://judge.me/api/docs

Retrieves the Featured Reviews Carousel widget HTML, which showcases specific reviews featured by the store on the homepage.

```APIDOC
## GET /widgets/featured_carousel

### Description
Retrieves the Featured Reviews Carousel widget HTML, which showcases specific reviews featured by the store on the homepage.

### Method
GET

### Endpoint
https://api.judge.me/api/v1/widgets/featured_carousel

### Parameters
None

### Response
#### Success Response (200)
- Returns the widget HTML content.

### Authorizations
- PrivateAPIKey__ShopDomain
- PublicAPIKey__ShopDomain
- OAuthAPIKey
```

--------------------------------

### GET /widgets/checkout_comments_widget

Source: https://judge.me/api/docs

Returns the Checkout Comments widget for a product (for Checkout Comments app only). You can specify the product using its handle, external ID, or Judge.me internal ID.

```APIDOC
## GET /widgets/checkout_comments_widget

### Description
Returns Checkout Comments widget for a product (for Checkout Comments app only). You can use product handle, external ID, or Judge.me internal ID to specify the product.

### Method
GET

### Endpoint
https://api.judge.me/api/v1/widgets/checkout_comments_widget

### Authorizations
- PrivateAPIKey__ShopDomain
- PublicAPIKey__ShopDomain
- OAuthAPIKey

### Parameters
#### Query Parameters
- **handle** (string) - Optional - Example: handle=example-product
- **external_id** (number) - Optional - External (Shopify) ID of the Product. Note: this is NOT internal Product ID of Judge.me. Example: external_id=999999
- **id** (number, internal_id) - Optional - Judge.me internal ID of the Product. Example: id=111

### Response
#### Success Response (200)
Successful operation

```

--------------------------------

### GET /widgets/reviews_tab

Source: https://judge.me/api/docs

Retrieves the Floating Reviews Tab widget HTML, which displays all product and store reviews via a floating button on any page. Supports pagination and review type selection.

```APIDOC
## GET /widgets/reviews_tab

### Description
Retrieves the Floating Reviews Tab widget HTML, which displays all product and store reviews via a floating button on any page. Supports pagination and review type selection.

### Method
GET

### Endpoint
https://api.judge.me/api/v1/widgets/reviews_tab

### Parameters
#### Query Parameters
- **page** (number) - Optional - For pagination. Example: page=1
- **per_page** (number) - Optional - For pagination. Example: per_page=5
- **review_type** (string) - Optional - Enum: "product-reviews" "shop-reviews". Whether to show product reviews, or shop reviews, default to product reviews. Example: review_type=product-reviews

### Response
#### Success Response (200)
- Returns the widget HTML content.

### Authorizations
- PrivateAPIKey__ShopDomain
- PublicAPIKey__ShopDomain
- OAuthAPIKey
```

--------------------------------

### GET /api/v1/reviews/{id}

Source: https://judge.me/api/docs

Retrieves detailed information about a specific review using its Judge.me internal ID. Requires PrivateAPIKey__ShopDomain and OAuthAPIKey authorization.

```APIDOC
## GET /api/v1/reviews/{id}

### Description
Get info of a specific review.

### Method
GET

### Endpoint
https://api.judge.me/api/v1/reviews/{id}

### Authorizations
- _PrivateAPIKey__ShopDomain_
- _OAuthAPIKey_

### Parameters
#### Path Parameters
- **id** (number) - Required - Judge.me internal ID of the Review. Example: -1

### Response
#### Success Response (200)
Review info

#### Response Example
```json
{
  "review": {
    "id": 111,
    "title": "Raw review title. This is not sanitized yet so do not print it out as-is in frontend.",
    "body": "Raw review body. This is not sanitized yet so do not print it out as-is in frontend.",
    "rating": 5,
    "pinned": false,
    "product_external_id": 999999,
    "product_title": "Example product",
    "product_handle": "example-product",
    "reviewer": {
      "id": 111,
      "email": "john@example.com",
      "name": "John Smith",
      "phone": "+123456789",
      "tags": ["tag1", "tag2", "tag3"],
      "accepts_marketing": true,
      "unsubscribed_at": "2020-02-20T20:20:20+00:00",
      "external_id": 999999
    },
    "source": "email",
    "curated": "ok",
    "hidden": false,
    "verified": "buyer",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "ip_address": "string",
    "has_published_pictures": false,
    "has_published_videos": false,
    "pictures": [
      {
        "hidden": true,
        "urls": {
          "small": "string",
          "compact": "string",
          "huge": "string",
          "original": "string"
        }
      }
    ]
  }
}
```

```

--------------------------------

### Create Review Request Payload (JSON)

Source: https://judge.me/api/docs

Example JSON payload for POST https://api.judge.me/api/v1/reviews. Includes required fields (shop_domain, platform, name, email, rating, body) and optional fields (id, reviewer_name_format, title, cf_answers, picture_urls, ip_addr). Note that 'id' is the external Shopify product ID, not the internal Judge.me product ID; if blank, the review is shop-level. The 'reviewer_name_format' default is full name, and Judge.me chooses the most restrictive option between reviewer and store settings.

```json
{
  "shop_domain": "example.myshopify.com",
  "platform": "shopify",
  "id": 999999,
  "email": "john@example.com",
  "name": "John Smith",
  "reviewer_name_format": "",
  "rating": 5,
  "title": "Review title",
  "body": "Review body",
  "cf_answers": [
    {
      "cf_question_id": 1,
      "value": "Yellow"
    },
    {
      "cf_question_id": 2,
      "value": "Big"
    },
    {
      "cf_question_id": 3,
      "value": "4/5"
    },
    {
      "cf_question_id": 4,
      "value": "Free text answer"
    }
  ],
  "picture_urls": [
    "https://pub-images.judge.me/judgeme/funny/big-pr.jpg",
    {
      "$ref": "#/components/examples/image_url/value"
    }
  ],
  "ip_addr": "123.123.123.123"
}
```

--------------------------------

### Authenticate with API key using X-Api-Token header

Source: https://judge.me/api/docs

Use this curl command to authenticate with a Judge.me API key. Pass the API key in the X-Api-Token header. Replace YOUR_API_TOKEN with your actual token and adjust the shop_domain and id parameters as needed.

```bash
curl -H "X-Api-Token: YOUR_API_TOKEN" https://api.judge.me/api/v1/widgets/product_review?shop_domain=example.myshopify.com&id=123
```

--------------------------------

### GET /api/v1/reviewers/{id}

Source: https://judge.me/api/docs

Gets information of the reviewers such as name and email. This is useful when you are building automated flow for users to follow up with reviewers.

```APIDOC
## GET /api/v1/reviewers/{id}

### Description
Gets information of the reviewers such as name and email. This is useful when you are building automated flow for users to follow up with reviewers.

### Method
GET

### Endpoint
https://api.judge.me/api/v1/reviewers/{id}

### Authorizations
- _PrivateAPIKey__ShopDomain_ _OAuthAPIKey_

### Parameters
#### Path Parameters
- **id** (number) - Required - Judge.me internal ID of the Reviewer. Set to `-1` and use `external_id` or `email` param to find Reviewer by external (Shopify) ID or by email of the Reviewer.

#### Query Parameters
- **external_id** (number) - Optional - External (Shopify) ID of the Reviewer. Note: this is NOT internal Reviewer ID of Judge.me.
- **email** (string <email>) - Optional - Email of the Reviewer.

### Response
#### Success Response (200)
- **reviewer** (object) - Reviewer info.
  - **id** (number) - Internal ID of the reviewer.
  - **email** (string) - Email of the reviewer.
  - **name** (string) - Name of the reviewer.
  - **phone** (string) - Phone number of the reviewer.
  - **tags** (array of strings) - Tags associated with the reviewer.
  - **accepts_marketing** (boolean) - Whether the reviewer accepts marketing.
  - **unsubscribed_at** (string) - Timestamp when the reviewer unsubscribed.
  - **external_id** (number) - External (Shopify) ID of the reviewer.

#### Response Example
{
  "reviewer": {
    "id": 111,
    "email": "john@example.com",
    "name": "John Smith",
    "phone": "+123456789",
    "tags": ["tag1", "tag2", "tag3"],
    "accepts_marketing": true,
    "unsubscribed_at": "2020-02-20T20:20:20+00:00",
    "external_id": 999999
  }
}

```

--------------------------------

### Create webhook response (200)

Source: https://judge.me/api/docs

Response includes shop_id, shop_domain, and the created webhook object with id, failure_count, key, and url.

```json
{
  "shop_id": 111,
  "shop_domain": "example.myshopify.com",
  "webhook": {
    "id": 111,
    "failure_count": 0,
    "key": "review/created",
    "url": "https://example.com/webhook/example.myshopify.com/settings/updated"
  }
}
```

--------------------------------

### General - Settings

Source: https://judge.me/api/docs

Endpoint for retrieving settings.

```APIDOC
## General - Settings

### getIndex
```

--------------------------------

### Widgets - Main Widgets

Source: https://judge.me/api/docs

Endpoints for displaying main widgets such as product review widget, preview badge, featured reviews carousel, floating reviews tab, all reviews page, and verified reviews count badge.

```APIDOC
## Widgets - Main Widgets

### getProduct Review Widget

### getProduct Preview Badge

### getFeatured Reviews Carousel

### getFloating Reviews Tab

### getAll Reviews Page

### getVerified Reviews Count Badge
```

--------------------------------

### POST /api/v1/reviews

Source: https://judge.me/api/docs

Creates a web review in the background, similar to submitting a review via the public form on product pages. No authorization is required. This endpoint does not create any review if the store disables web reviews.

```APIDOC
## POST /api/v1/reviews

### Description
Creates a web review in the background, similar to submitting a review via the public form on product pages. No authorization is required. This endpoint does not create any review if the store disables web reviews.

### Method
POST

### Endpoint
https://api.judge.me/api/v1/reviews

### Parameters
#### Request Body
- **shop_domain** (string) - Required - Domain of the shop
- **platform** (string) - Required - Enum: "shopify" "woocommerce" "bigcommerce" - Platform of the shop
- **name** (string, person_name) - Required
- **email** (string, email) - Required
- **rating** (number, rating) - Required - Enum: 1 2 3 4 5
- **body** (string) - Required
- **id** (number) - Optional - External (Shopify) ID of the Product. Note: this is NOT internal Product ID of Judge.me. If blank, the review is considered as a shop-level review.
- **reviewer_name_format** (string) - Optional - Enum: "" "last_initial" "all_initials" "anonymous" - How the reviewers want to show their name publicly. Default is showing full name. Stores can also choose how they want to display reviewer's names in all reviews on their stores. When showing reviews, Judge.me will choose the most restrictive option between reviewer's option and store's option. For example, if a reviewer set their display format as all_initials while the store sets the format as last_initial, we will show the reviewer's name as all initials, which is J.S., not John S..
- **title** (string) - Optional
- **cf_answers** (Array of objects) - Optional - Answers to the shop's custom forms
- **picture_urls** (Array of strings) - Optional
- **ip_addr** (string) - Optional - IP address of the reviewer, used to display location of the review. If blank, Judge.me will use IP address that makes the API request

### Request Example
{
  "shop_domain": "example.myshopify.com",
  "platform": "shopify",
  "id": 999999,
  "email": "john@example.com",
  "name": "John Smith",
  "reviewer_name_format": "",
  "rating": 5,
  "title": "Review title",
  "body": "Review body",
  "cf_answers": [
    {
      "cf_question_id": 1,
      "value": "Yellow"
    },
    {
      "cf_question_id": 2,
      "value": "Big"
    },
    {
      "cf_question_id": 3,
      "value": "4/5"
    },
    {
      "cf_question_id": 4,
      "value": "Free text answer"
    }
  ],
  "picture_urls": [
    "https://pub-images.judge.me/judgeme/funny/big-pr.jpg"
  ],
  "ip_addr": "123.123.123.123"
}

### Response
#### Success Response (200)
- **post/reviews** - Description: Judge.me API server

#### Response Example
(No response body example provided in the source.)

```

--------------------------------

### Reviews Overview

Source: https://judge.me/api/docs

Overview of the reviews endpoints. These endpoints provide access to review information for synchronization, display, webhook events, and management. Note: these endpoints respond raw review information, which may include unpublished reviews or unsanitized content.

```APIDOC
## Reviews

### Description
You can use the reviews endpoints to access review information. Common use cases include:
- Synchronize and display reviews in your admin dashboard.
- Get event of new reviews (via webhook) to perform an action on your side.
- Let users manage reviews (publish/hide) on your side.

Note: these endpoints respond **raw** review information, which may include **unpublished reviews**, or review content that is **not sanitized** yet (so risks of XSS). To render review content on storefront, please use widget endpoints instead.

```

--------------------------------

### General - Replies

Source: https://judge.me/api/docs

Endpoint for creating replies.

```APIDOC
## General - Replies

### postCreate
```

--------------------------------

### Authenticate API Request with Bearer Token

Source: https://judge.me/api/docs

Use the access token obtained from the OAuth flow in the Authorization header. The token can also be passed as an api_token query parameter. Do not use the X-Api-Token header for OAuth tokens; it only works for private/public API keys and will fail with 'Failed to authenticate. Shop domain or Api Token is wrong'.

```bash
curl -H "Authorization: Bearer YOUR_ACCESS_TOKEN" "https://api.judge.me/api/v1/reviews?shop_domain=example.myshopify.com"
```

--------------------------------

### POST /api/v1/webhooks

Source: https://judge.me/api/docs

Creates a webhook in Judge.me with a key and a URL. When an event associated with the key happens, Judge.me will send a POST request to the webhook's URL.

```APIDOC
## POST /api/v1/webhooks

### Description
Creates a webhook in Judge.me with a `key` and a `url`. When an event associated with `key` happens, Judge.me will send a POST request to the webhook's `url`.

### Method
POST

### Endpoint
https://api.judge.me/api/v1/webhooks

### Authorizations
- _PrivateAPIKey__ShopDomain__OAuthAPIKey_

### Parameters
#### Request Body
- **webhook** (object) - Required - The webhook object containing key and url.
  - **key** (string) - Required - The webhook key. Enum: "widget/settings/updated", "widget/review_widget/updated", "widget/preview_badge/updated", "widget/all_reviews_count/updated", "widget/all_reviews_rating/updated", "widget/shop_reviews_count/updated", "widget/shop_reviews_rating/updated", "widget/verified_badge/updated", "widget/all_reviews_page/updated", "widget/featured_carousel/updated", "widget/reviews_tab/updated", "widget/html_miracle/updated", "widget/product_comment/updated", "review/created", "review/updated", "review/created_fail"
  - **url** (string) - Required - The webhook URL.

### Request Example
{
  "webhook": {
    "key": "review/created",
    "url": "https://example.com/webhook/example.myshopify.com/settings/updated"
  }
}

### Response
#### Success Response (200)
- **shop_id** (integer) - The shop ID.
- **shop_domain** (string) - The shop domain.
- **webhook** (object) - The created webhook object.
  - **id** (integer) - The webhook ID.
  - **failure_count** (integer) - The number of failures.
  - **key** (string) - The webhook key.
  - **url** (string) - The webhook URL.

#### Response Example
{
  "shop_id": 111,
  "shop_domain": "example.myshopify.com",
  "webhook": {
    "id": 111,
    "failure_count": 0,
    "key": "review/created",
    "url": "https://example.com/webhook/example.myshopify.com/settings/updated"
  }
}
```

--------------------------------

### DELETE /shops

Source: https://judge.me/api/docs

Uninstalls the store from Judge.me. No request body is required.

```APIDOC
## [DELETE] /shops

### Description
Uninstall the store from Judge.me.

### Method
DELETE

### Endpoint
https://api.judge.me/api/v1/shops

### Authorizations
- PrivateAPIKey__ShopDomain
- OAuthAPIKey

### Response
#### Success Response (200)
Uninstalled shop successfully.

```

--------------------------------

### POST /api/v1/webhooks/bulk_create

Source: https://judge.me/api/docs

Bulk creates webhooks. The request body contains an array of webhook objects, each with a key and a URL. The response is a 200 status code.

```APIDOC
## POST /api/v1/webhooks/bulk_create

### Description
Bulk creates webhooks. The request body contains an array of webhook objects, each with a key and a URL.

### Method
POST

### Endpoint
https://api.judge.me/api/v1/webhooks/bulk_create

### Authorizations
- _PrivateAPIKey__ShopDomain__OAuthAPIKey_

### Parameters
#### Request Body
- **webhooks** (Array of objects (RequestWebhook)) - Required - Array of webhook objects.
  - **key** (string) - Required - The webhook event key (e.g., "review/created").
  - **url** (string) - Required - The URL to send the webhook to.

### Request Example
{
  "webhooks": [
    {
      "key": "review/created",
      "url": "https://example.com/webhook/example.myshopify.com/settings/updated"
    }
  ]
}

### Response
#### Success Response (200)
- No response body is documented.

```

--------------------------------

### Update shop request payload (application/json)

Source: https://judge.me/api/docs

JSON payload for updating shop information. Required fields include domain, custom_domain, email, owner, phone, name, country, timezone, and plan. The domain and custom_domain use the placeholder {{shop_domain}}.

```json
{
  "domain": "{{shop_domain}}",
  "custom_domain": "{{shop_domain}}",
  "email": "john@example.com",
  "owner": "John Smith",
  "phone": "+123456789",
  "name": "Shop Name",
  "country": "US",
  "timezone": "(GMT-05:00) America/New_York",
  "plan": "basic"
}
```
Tokens:
Raw