GetRating developer docs

Everything you can build on today: a review-request API, a REST API for reviews, signed webhooks and Zapier-compatible endpoints. All requests go to https://getrating.co over HTTPS.

Authentication

Create an API key in the dashboard under Integrations. The full key is shown once, so store it securely. Send it in the X-API-Key header. Revoked, expired or suspended-account keys return 401 or 403.

curl -H "X-API-Key: $GETRATING_API_KEY" \
  "https://getrating.co/api/v1/reviews?locationId=LOCATION_ID&page=1&limit=20"

Send a review request

POST /api/v1/review-requests

The single entry point for POS, booking, field-service and CRM systems, Shopify Flow and Zapier: call it when a sale, visit or job is completed and GetRating queues the location's active after-visit email campaign and/or SMS campaign for that customer. It sends after the campaign's delay, or at sendAt (ISO 8601, up to 30 days ahead). Every customer you send gets the same request; there is no filtering by rating.

  • Requires an API key with write permission (keys created on the Zapier screen have it). Read-only keys get 403 insufficient_scope.
  • Body: locationId, customer (name, email and/or phone in international format), optional channels (email, sms; default both), optional sendAt, optional reference, and consent: true to confirm the customer agreed to be contacted.
  • Campaign texts can use {{customer_name}} and {{review_link}}.
  • Send an Idempotency-Key header (for example the order ID). Retrying with the same key and body within 24 hours returns the first response with Idempotent-Replayed: true; the same key with a different body returns 422.
  • A channel is skipped with a reason when there is no contact for it (no_contact), no active after-visit campaign (no_active_campaign), the plan does not include it (plan_not_included) or the customer was asked for this location in the last 30 days (recently_requested).
  • Limits: 60 requests per minute per key and 1,000 per location per day; over the limit returns 429 with Retry-After.
curl -X POST "https://getrating.co/api/v1/review-requests" \
  -H "X-API-Key: $GETRATING_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: order-10421" \
  -d '{
    "locationId": "LOCATION_ID",
    "customer": { "name": "Kari", "email": "[email protected]", "phone": "+4791234567" },
    "channels": ["email", "sms"],
    "consent": true
  }'
HTTP/1.1 202 Accepted

{
  "locationId": "LOCATION_ID",
  "channels": [
    { "channel": "email", "status": "scheduled", "messageId": "clx...", "scheduledFor": "2026-10-26T13:00:00.000Z" },
    { "channel": "sms", "status": "skipped", "reason": "plan_not_included" }
  ]
}

REST API

GET /api/v1/reviews

Returns approved public reviews for one of your locations, newest first. Query parameters: locationId (required), page (default 1) and limit (1–100, default 20). Requires an API key.

{
  "reviews": [
    {
      "id": "clx...",
      "stars": 5,
      "feedback": "Great service",
      "reviewerName": "Anna",
      "publishedAt": "2026-09-30T12:00:00.000Z"
    }
  ],
  "pagination": { "page": 1, "limit": 20, "total": 42, "totalPages": 3 },
  "summary": {
    "avgRating": 4.7,
    "totalReviews": 42,
    "distribution": { "1": 0, "2": 1, "3": 2, "4": 8, "5": 31 }
  }
}

GET /api/v1/reviews/public/{slug}

The same review list for a location's public slug, without an API key. Limited to 30 requests per minute per client; over the limit returns 429 with a Retry-After header.

Webhooks

Add webhook endpoints under Dashboard → Integrations. Each webhook subscribes to one or more events:

  • new_feedback: sent when a customer submits written feedback, privately or as a public GetRating review
  • low_rating: sent when a customer gives a 1- or 2-star rating, with or without written feedback
  • feedback_resolved: sent once when feedback is marked resolved, from the dashboard or through the Zapier update_review_status action
  • weekly_summary: weekly performance summary, sent with the weekly summary email

Deliveries are JSON POST requests with the headers X-Webhook-Event, X-Webhook-ID (the webhook), X-Webhook-Delivery (unique per event and unchanged across retries, so you can drop duplicates) and X-Webhook-Timestamp. When you set a secret, X-GetRating-Signature is t=<unix seconds>,v1=<hex HMAC-SHA256>, where the HMAC is computed with your secret over the timestamp, a dot and the raw body (t.body). Reject requests whose timestamp is more than 5 minutes from your clock to stop replays. Each retry is signed again with a new timestamp. The older X-Webhook-Signature header (sha256= and the HMAC of the body alone) is still sent so existing receivers keep working; new integrations should verify X-GetRating-Signature. Requests time out after 10 seconds. Timeouts, network errors, 408, 425, 429 and 5xx responses are retried up to 3 times; other responses are not retried. Endpoints must resolve to a public address, and redirects are not followed. You can send a test event and inspect recent deliveries in the dashboard.

import { createHmac, timingSafeEqual } from "node:crypto"

const TOLERANCE_SECONDS = 300

// header: the X-GetRating-Signature value, e.g. "t=1767225600,v1=5f2b..."
export function isValidSignature(rawBody: string, header: string, secret: string) {
  const parts = Object.fromEntries(header.split(",").map((p) => p.trim().split("=", 2)))
  const timestamp = Number(parts.t)
  if (!Number.isInteger(timestamp) || !parts.v1) return false
  if (Math.abs(Date.now() / 1000 - timestamp) > TOLERANCE_SECONDS) return false

  const expected = createHmac("sha256", secret).update(`${timestamp}.${rawBody}`).digest("hex")
  const a = Buffer.from(expected)
  const b = Buffer.from(parts.v1)
  return a.length === b.length && timingSafeEqual(a, b)
}

Zapier endpoints

These endpoints follow Zapier's REST hook and polling patterns and use the same X-API-Key header.

  • POST /api/zapier/auth with { "api_key": "..." } tests a key.
  • POST /api/zapier/webhooks subscribes a target_url to an event_type (new_feedback, low_rating, feedback_resolved, weekly_summary, external_review_received, alert_triggered), optionally for one location_id. DELETE with webhook_id unsubscribes. Each event is posted to the target URL as JSON when it happens, with the same headers, timeout and retries as webhooks; a 410 Gone response removes the subscription. Review events use the same fields as the reviews polling trigger.
  • GET /api/zapier/triggers/reviews, /triggers/resolved, /triggers/locations and /triggers/alerts return sample and polling data. Reviews accept location_id, since, status, min_stars, max_stars and limit (max 100).
  • POST /api/zapier/actions?action=… runs create_review, update_review_status (open, in_progress, resolved), send_reply (sends the reply to the customer by email or SMS, like a reply from the dashboard; Business plan) or create_alert.

Not sure where to start? The integrations page explains what each connection does.

What the API does not cover

  • No endpoints for creating or editing locations, campaigns or billing.
  • The review-request endpoint uses your existing after-visit campaigns; it does not take a custom message.
  • No access to reviews on Google or other sites through the reviews API; it returns reviews collected in GetRating.
  • No official SDKs. Use any HTTP client.

Frequently asked questions

Does GetRating have an API?

Yes. A REST API sends a review request to one customer (for POS, booking and CRM systems) and returns the approved public reviews collected through GetRating, authenticated with an API key. Webhooks and Zapier endpoints cover events and actions.

Which plans include API access?

API keys, webhooks and the Zapier endpoints are available on every plan, including Free. Review requests use your email campaigns (Growth and Business) or SMS campaigns (Business).

Can the API post reviews to Google?

No. Nothing in GetRating writes reviews to Google or other review sites. The API reads reviews collected through GetRating, and the Zapier create-review action records feedback inside GetRating only.

Ask every customer for a review

Free plan for 1 location. No credit card required.

Start free