Query responses

Query responses

curl --request GET \
  --url https://api.gotohuman.com/responses \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.gotohuman.com/responses', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.gotohuman.com/responses",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.gotohuman.com/responses"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.gotohuman.com/responses")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

[
  {
    "reviewId": "abc123456",
    "createdAt": "2025-03-12T22:25:42.415Z",
    "respondedAt": "2025-03-12T22:26:15.253Z",
    "response": "approved",
    "fields": {
      "yourFieldId1": {
        "suggestedValue": "Hi Lenny, I saw the news about your latest model. Given your momentum in the AI space, influencer marketing could be a powerful tool to further engage and expand your developer community...",
        "approvedValue": "Hello Lenny, I tested your latest model and it looks really promising. Given your momentum in the AI space, influencer marketing could be a powerful tool to further engage and expand your developer community..."
      },
      "yourFieldId2": {
        "suggestedValue": "...",
        "approvedValue": "..."
      }
    }
  },
  ...
]

{
  "yourFieldId1": [
    {
      "reviewId": "abc123456",
      "createdAt": "2025-03-12T22:25:42.415Z",
      "respondedAt": "2025-03-12T22:26:15.253Z",
      "response": "approved",
      "suggestedValue": "Hi Lenny, I saw the news about your latest model. Given your momentum in the AI space, influencer marketing could be a powerful tool to further engage and expand your developer community...",
      "approvedValue": "Hello Lenny, I tested your latest model and it looks really promising. Given your momentum in the AI space, influencer marketing could be a powerful tool to further engage and expand your developer community..."
    },
    ...
  ]
}

[
  {
    "yourFieldId1": "Hello Lenny, I tested your latest model and it looks really promising. Given your momentum in the AI space, influencer marketing could be a powerful tool to further engage and expand your developer community...",
    "yourFieldId2": "..."
  },
  ...
]

{
  "yourFieldId1": [
    "Hello Lenny, I tested your latest model and it looks really promising. Given your momentum in the AI space, influencer marketing could be a powerful tool to further engage and expand your developer community...",
    "..."
  ],
  "yourFieldId2": [
    "...",
    "..."
  ]
}

GET

responses

Query responses

curl --request GET \
  --url https://api.gotohuman.com/responses \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.gotohuman.com/responses', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.gotohuman.com/responses",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.gotohuman.com/responses"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.gotohuman.com/responses")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

[
  {
    "reviewId": "abc123456",
    "createdAt": "2025-03-12T22:25:42.415Z",
    "respondedAt": "2025-03-12T22:26:15.253Z",
    "response": "approved",
    "fields": {
      "yourFieldId1": {
        "suggestedValue": "Hi Lenny, I saw the news about your latest model. Given your momentum in the AI space, influencer marketing could be a powerful tool to further engage and expand your developer community...",
        "approvedValue": "Hello Lenny, I tested your latest model and it looks really promising. Given your momentum in the AI space, influencer marketing could be a powerful tool to further engage and expand your developer community..."
      },
      "yourFieldId2": {
        "suggestedValue": "...",
        "approvedValue": "..."
      }
    }
  },
  ...
]

{
  "yourFieldId1": [
    {
      "reviewId": "abc123456",
      "createdAt": "2025-03-12T22:25:42.415Z",
      "respondedAt": "2025-03-12T22:26:15.253Z",
      "response": "approved",
      "suggestedValue": "Hi Lenny, I saw the news about your latest model. Given your momentum in the AI space, influencer marketing could be a powerful tool to further engage and expand your developer community...",
      "approvedValue": "Hello Lenny, I tested your latest model and it looks really promising. Given your momentum in the AI space, influencer marketing could be a powerful tool to further engage and expand your developer community..."
    },
    ...
  ]
}

[
  {
    "yourFieldId1": "Hello Lenny, I tested your latest model and it looks really promising. Given your momentum in the AI space, influencer marketing could be a powerful tool to further engage and expand your developer community...",
    "yourFieldId2": "..."
  },
  ...
]

{
  "yourFieldId1": [
    "Hello Lenny, I tested your latest model and it looks really promising. Given your momentum in the AI space, influencer marketing could be a powerful tool to further engage and expand your developer community...",
    "..."
  ],
  "yourFieldId2": [
    "...",
    "..."
  ]
}

See Introduction for the base URL and authentication.

Query Parameters

string

required

The ID of the review type.

string

required

The comma-separated IDs of the fields you are interested in.

string

Filter by review status. Possible values: approved, rejected.

string

Filter by response values. See Filtering Response Values for more details.

boolean

default:false

Whether to group the responses by field. If not, grouped by review.

boolean

default:false

Lists only the response values for approved reviews.

boolean

default:false

Lists only the request values for rejected reviews.

number

The number of responses to return. Maximum 500 (Team: 100, Starter: limited).

[
  {
    "reviewId": "abc123456",
    "createdAt": "2025-03-12T22:25:42.415Z",
    "respondedAt": "2025-03-12T22:26:15.253Z",
    "response": "approved",
    "fields": {
      "yourFieldId1": {
        "suggestedValue": "Hi Lenny, I saw the news about your latest model. Given your momentum in the AI space, influencer marketing could be a powerful tool to further engage and expand your developer community...",
        "approvedValue": "Hello Lenny, I tested your latest model and it looks really promising. Given your momentum in the AI space, influencer marketing could be a powerful tool to further engage and expand your developer community..."
      },
      "yourFieldId2": {
        "suggestedValue": "...",
        "approvedValue": "..."
      }
    }
  },
  ...
]

{
  "yourFieldId1": [
    {
      "reviewId": "abc123456",
      "createdAt": "2025-03-12T22:25:42.415Z",
      "respondedAt": "2025-03-12T22:26:15.253Z",
      "response": "approved",
      "suggestedValue": "Hi Lenny, I saw the news about your latest model. Given your momentum in the AI space, influencer marketing could be a powerful tool to further engage and expand your developer community...",
      "approvedValue": "Hello Lenny, I tested your latest model and it looks really promising. Given your momentum in the AI space, influencer marketing could be a powerful tool to further engage and expand your developer community..."
    },
    ...
  ]
}

[
  {
    "yourFieldId1": "Hello Lenny, I tested your latest model and it looks really promising. Given your momentum in the AI space, influencer marketing could be a powerful tool to further engage and expand your developer community...",
    "yourFieldId2": "..."
  },
  ...
]

{
  "yourFieldId1": [
    "Hello Lenny, I tested your latest model and it looks really promising. Given your momentum in the AI space, influencer marketing could be a powerful tool to further engage and expand your developer community...",
    "..."
  ],
  "yourFieldId2": [
    "...",
    "..."
  ]
}

Filtering Response Values

The filterResponseValues parameter allows you to filter responses based on their field values. This parameter accepts an array of filter objects that are combined with AND logic. Filter Array (as JSON string):

[
  {
    "field": "urgency.value",
    "operation": "==",
    "value": "urgent"
  },
  {
    "field": "rating.value",
    "operation": "\u003E=",
    "value": 4
  }
]

The filterResponseValues parameter must be passed as a URL-encoded JSON string array. Important: Do not pass an actual array object, but a JSON string. In n8n expressions, you can use yourArray.toJsonString() to convert an array to a JSON string. Full Encoded Request:

GET /fetchResponses?formId=123&filterResponseValues=%5B%7B%22field%22%3A%22urgency.value%22%2C%22operation%22%3A%22equal%22%2C%22value%22%3A%22urgent%22%7D%2C%7B%22field%22%3A%22rating.value%22%2C%22operation%22%3A%22greaterThanOrEqual%22%2C%22value%22%3A4.0%7D%5D

Supported Operations

Scalar Operations:

== - Field equals value (example)
!= - Field does not equal value (example)
> - Field > value (example)
>= - Field >= value (example)
< - Field < value (example)
<= - Field <= value (example)
contains - Field contains substring (example)
startsWith - Field starts with substring (example)
endsWith - Field ends with substring (example)
isTrue - Field is true (example)
isFalse - Field is false (example)

Array Operations:

arrayIncludes - Array contains value (example)
arrayExcludes - Array does not contain value (example)
arrayIsEmpty - Array is empty (example)
arrayIsNotEmpty - Array is not empty (example)

The filtering is done on the responseValues field that you receive in your response webhooks:

// example structure. Look at your webhook responses to see the structure for your review type.{  "responseValues": {    "keyword": {      "value": "Lirum Larum Ipsum Dolor Sit Amet",      "wasEdited": false    },    "content": {      "value": "Excepteur sint occaecat cupidatat non proident...",      "wasEdited": false    },    "customerValue": {      "value": 123,      "wasEdited": false    },    "rating": {      "value": 4.5,      "wasEdited": false    },    "urgency": {      "value": "urgent"    },    "categories": {      "value": [        {"id": "ecommerce", "label": "eCommerce"},        {"id": "health", "label": "Health"}      ]    }  },  ...}