One completed Response

GET/responses/{responseId}

Authorization

AuthorizationBearer token · headerrequired

A Workspace API key (fnr_live_…). Grants responses:read only.

AuthorizationOAuth2 access token · headerrequired

Scopes:responses:read

Path parameters

responseIdstring<uuid>required

Response id.

Responses

200

The Response.

eventany

createdAtstring<date-time>

dataobject

Show properties

formIdstring

formTitlestring

responseIdstring

respondentEmailstring | null

completedAtstring<date-time>

answersobject[]

Show properties

Array of object

fieldIdstring

labelstring

typestring

valuestring

rawValueany

fieldsobject

hiddenFieldsobject

metadataobject

401

Missing or invalid token.

errorstringrequired

Short message; same as message.

codestringrequired

Allowed:invalid_requestunauthorizedinsufficient_scopenot_foundmethod_not_allowedrate_limitedinternal_error

messagestringrequired

hintstringrequired

How to resolve the error.

docsstringrequired

Where the API is described.

403

The token lacks the required scope.

errorstringrequired

Short message; same as message.

codestringrequired

Allowed:invalid_requestunauthorizedinsufficient_scopenot_foundmethod_not_allowedrate_limitedinternal_error

messagestringrequired

hintstringrequired

How to resolve the error.

docsstringrequired

Where the API is described.

404

No such completed Response in this Workspace.

errorstringrequired

Short message; same as message.

codestringrequired

Allowed:invalid_requestunauthorizedinsufficient_scopenot_foundmethod_not_allowedrate_limitedinternal_error

messagestringrequired

hintstringrequired

How to resolve the error.

docsstringrequired

Where the API is described.

429

Rate limited; see the Retry-After header.

errorstringrequired

Short message; same as message.

codestringrequired

Allowed:invalid_requestunauthorizedinsufficient_scopenot_foundmethod_not_allowedrate_limitedinternal_error

messagestringrequired

hintstringrequired

How to resolve the error.

docsstringrequired

Where the API is described.

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Parameters

responseIdpath*Response id.

Request

curl -X GET 'https://finerlise.com/api/v1/responses/497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'

const response = await fetch("https://finerlise.com/api/v1/responses/497f6eca-6276-4993-bfeb-53cbbbba6f08", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json"
  }
});

import requests

response = requests.get(
    "https://finerlise.com/api/v1/responses/497f6eca-6276-4993-bfeb-53cbbbba6f08",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json"
    },
)

Response

{
  "event": "response.completed",
  "createdAt": "2019-08-24T14:15:22Z",
  "data": {
    "formId": "string",
    "formTitle": "string",
    "responseId": "string",
    "respondentEmail": "string",
    "completedAt": "2019-08-24T14:15:22Z",
    "answers": [
      {
        "fieldId": "string",
        "label": "string",
        "type": "string",
        "value": "string",
        "rawValue": null
      }
    ],
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "hiddenFields": {
      "property1": "string",
      "property2": "string"
    },
    "metadata": {}
  }
}

{
  "error": "string",
  "code": "invalid_request",
  "message": "string",
  "hint": "string",
  "docs": "string"
}

{
  "error": "string",
  "code": "invalid_request",
  "message": "string",
  "hint": "string",
  "docs": "string"
}

{
  "error": "string",
  "code": "invalid_request",
  "message": "string",
  "hint": "string",
  "docs": "string"
}

{
  "error": "string",
  "code": "invalid_request",
  "message": "string",
  "hint": "string",
  "docs": "string"
}