API Documentation

Get all testimonials for a brand

GET/brands/:id/testimonials

Example URI

{
  "code": "OK",
  "data": [
    {
      "id": "edab9d40-3c3f-4c43-8aff-ecba3dd643ab",
      "brand": "500b5876-5466-4f9c-888d-45b8bdf98e92",
      "content": "This is an amazing real estate service! They helped us find our dream home.",
      "rating": 5,
      "created_at": 1778872337.006007,
      "updated_at": 1778872337.006007,
      "deleted_at": null,
      "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
      "updated_by": null,
      "captured_at": 1778872337.006007,
      "tags": [],
      "source": "Manual",
      "zillow_review": null,
      "google_review": null,
      "type": "testimonial"
    },
    {
      "id": "4256d612-f852-402b-a62c-e7854d5ec8e7",
      "brand": "500b5876-5466-4f9c-888d-45b8bdf98e92",
      "content": "This is an amazing real estate service! They helped us find our dream home.",
      "rating": 5,
      "created_at": 1778872337.006007,
      "updated_at": 1778872337.006007,
      "deleted_at": null,
      "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
      "updated_by": null,
      "captured_at": 1778872337.006007,
      "tags": [],
      "source": "Manual",
      "zillow_review": null,
      "google_review": null,
      "type": "testimonial"
    },
    {
      "id": "5de33c9d-0f11-4d16-a782-a23f6041fdde",
      "brand": "500b5876-5466-4f9c-888d-45b8bdf98e92",
      "content": "Great service!",
      "rating": null,
      "created_at": 1778872337.006007,
      "updated_at": 1778872337.006007,
      "deleted_at": null,
      "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
      "updated_by": null,
      "captured_at": 1778872337.006007,
      "tags": [],
      "source": "Manual",
      "zillow_review": null,
      "google_review": null,
      "type": "testimonial"
    }
  ],
  "info": {
    "count": 3,
    "total": 0
  }
}

Get a specific testimonial

GET/brands/:id/testimonials/:testimonial

Example URI

{
  "code": "OK",
  "data": {
    "id": "edab9d40-3c3f-4c43-8aff-ecba3dd643ab",
    "brand": "500b5876-5466-4f9c-888d-45b8bdf98e92",
    "contact": {
      "id": "43450275-8d50-4343-b061-0c0c64f33a8b",
      "display_name": "Johnny",
      "partner_name": "Jane Doe",
      "brand": "f4d3503d-6646-4319-9c45-324ab0176ffd",
      "brand_id": "f4d3503d-6646-4319-9c45-324ab0176ffd",
      "user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
      "sort_field": "Johnny",
      "last_touch": null,
      "last_touch_action": null,
      "next_touch": null,
      "touch_freq": null,
      "ios_address_book_id": null,
      "android_address_book_id": null,
      "created_at": 1778872338.660905,
      "updated_at": 1778872337.006007,
      "deleted_at": null,
      "created_for": "direct_request",
      "updated_for": "direct_request",
      "deleted_for": null,
      "title": null,
      "first_name": "John",
      "partner_first_name": "Jane",
      "middle_name": "M.",
      "last_name": "Doe",
      "partner_last_name": "Doe",
      "marketing_name": null,
      "nickname": "Johnny",
      "email": "[email protected]",
      "primary_email": "[email protected]",
      "emails": [
        "[email protected]"
      ],
      "parked": false,
      "partner_email": "[email protected]",
      "phone_number": "+989124834198",
      "primary_phone_number": "+989124834198",
      "phone_numbers": [
        "+989124834198"
      ],
      "company": "Rechat",
      "birthday": "1970-01-12T00:00:00.000Z",
      "profile_image_url": "https://inomics.com/sites/default/files/pictures/picture-95970-1460131169.png",
      "cover_image_url": "https://inomics.com/sites/default/files/pictures/picture-95970-1460131169.png",
      "job_title": "Contact Test Subject",
      "source_type": "ExplicitlyCreated",
      "source": null,
      "website": [
        "http://www.gholi.com"
      ],
      "tags": [
        "poo",
        "foo",
        "New"
      ],
      "address": [
        {
          "city": "Dallas",
          "full": "Street, Dallas Texas 72890",
          "name": "Street",
          "type": "stdaddr",
          "extra": "Office",
          "line1": "Street",
          "line2": "Dallas Texas 72890",
          "state": "Texas",
          "country": "US",
          "postcode": "72890"
        }
      ],
      "type": "contact"
    },
    "content": "This is an amazing real estate service! They helped us find our dream home.",
    "rating": 5,
    "created_at": 1778872337.006007,
    "updated_at": 1778872337.006007,
    "deleted_at": null,
    "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
    "updated_by": null,
    "captured_at": 1778872337.006007,
    "tags": [],
    "source": "Manual",
    "zillow_review": null,
    "google_review": null,
    "type": "testimonial"
  }
}

Get testimonial settings

GET/brands/:id/testimonials/settings

Returns the testimonial capture settings for a brand, including the template instance used for the capture form.

Example URI

{
  "code": "OK",
  "data": {
    "id": "bb1f3048-7677-40c6-89e6-75a39b52ff36",
    "brand": "500b5876-5466-4f9c-888d-45b8bdf98e92",
    "template_instance": {
      "id": "df18b76d-3c4f-46c3-a666-0df766e27ff7",
      "created_at": 1778872337.006007,
      "html": "SOME HTML",
      "file": {
        "id": "a495d623-2d63-400e-924b-c4542b0c56cf",
        "created_at": 1778872340.597857,
        "updated_at": 1778872340.597857,
        "deleted_at": null,
        "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
        "path": "templates/instances/ff1f7e10-5091-11f1-8248-cf8ab660e2ca.png",
        "name": "image.png",
        "public": true,
        "type": "file",
        "url": "https://test.cloudfront.net/templates/instances/ff1f7e10-5091-11f1-8248-cf8ab660e2ca.png",
        "preview_url": "https://test.cloudfront.net/templates/instances/ff1f7e10-5091-11f1-8248-cf8ab660e2ca.png",
        "mime": "image/png"
      },
      "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
      "branch": "http://mock-branch-url",
      "updated_at": 1778872337.006007,
      "deleted_at": null,
      "type": "template_instance"
    },
    "created_at": 1778872337.006007,
    "updated_at": 1778872337.006007,
    "collection_method": null,
    "user": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
    "google_business_account": null,
    "google_business_location": null,
    "type": "testimonial_settings"
  }
}

Search Zillow reviewees

GET/zillow/reviewees/search{?q}

Searches the global Zillow reviewees catalog. Used by the web client to populate the picker UI before calling [PUT /brands/:id/testimonials/zillow]. The match is a case-insensitive substring (ILIKE '%q%') OR’d across screen_name, full_name, business_name, and email.

Query parameters:

Example URI

{
  "code": "OK",
  "data": [
    {
      "id": "d3b155f4-68fc-4a49-a76c-396e3e1dc9bb",
      "reviewee_key": "test-reviewee-key-1",
      "account_id": "test-account-1",
      "screen_name": "testagent",
      "full_name": "Test Agent",
      "title": "Real Estate Agent",
      "email": "[email protected]",
      "business_name": "Test Realty",
      "profile_url": "https://www.zillow.com/profile/testagent",
      "review_request_url": "https://www.zillow.com/profile/testagent/review",
      "review_count": 0,
      "average_review_rating": null,
      "bridge_modification_timestamp": "2026-01-01T00:00:00.000Z",
      "created_at": 1778872337.006007,
      "updated_at": 1778872337.006007,
      "deleted_at": null,
      "type": "zillow_reviewee"
    }
  ],
  "info": {
    "count": 1,
    "total": 0
  }
}

Testimonial capture form

GET/brands/:id/testimonials/:user/capture{?method}

Public endpoint (no authentication required). Behavior:

1. If collection_method is set on the user’s settings, that wins — the request is treated as if ?method= matched it (Zillow/Google → 302 redirect, Rechat → rendered form). The ?method= query parameter is ignored in this case.

2. Otherwise, if ?method=zillow|google|rechat is provided, route accordingly.

3. Otherwise, if at least one external destination (Google or Zillow) is connected, render a chooser page listing the available options plus None (Rechat). Each link re-hits this endpoint with ?method=....

4. Otherwise, render the Rechat capture form HTML (uses the stored template instance, or falls back to the brand’s TestimonialCapture template).

Method semantics:

• method=zillow — 302 redirect to the Zillow reviewee’s review_request_url.

• method=google — looks up the connected location’s metadata.newReviewUri via the Business Information API (using the user’s stored credential) and 302 redirects to it.

• method=rechat — renders the Rechat capture form HTML.

Optional query parameter contact (uuid) can be passed to pre-populate contact data in the Rechat form.

Example URI

<!doctype html>
        <html lang="en">
        <head>
        <meta charset="utf-8">
        <title>Leave a testimonial</title>
        </head>
        <body>
        <h1>Leave a testimonial</h1>
        <p>Choose where you'd like to leave your review:</p>
        <ul>

      <li><a href="/brands/500b5876-5466-4f9c-888d-45b8bdf98e92/testimonials/80a227b2-29a0-11e7-b636-e4a7a08e15d4/capture?method=google">Google</a></li>

      <li><a href="/brands/500b5876-5466-4f9c-888d-45b8bdf98e92/testimonials/80a227b2-29a0-11e7-b636-e4a7a08e15d4/capture?method=zillow">Zillow</a></li>

      <li><a href="/brands/500b5876-5466-4f9c-888d-45b8bdf98e92/testimonials/80a227b2-29a0-11e7-b636-e4a7a08e15d4/capture?method=rechat">None</a></li>

    </ul>
    </body>
    </html>