Tenant API - Forms

Get form response keys

Only the client that created the form template associated with the response can call this endpoint.

Given a tenant key and a form template key returns the form response key associated with form responses submitted by users.

get/v2/tenant/{tenantKey}/form/{formTemplateKey}/responses

Request

  • Base URL: https://sender.api.kivra.com
  • URL: https://sender.api.kivra.com/v2/tenant/{tenantKey}/form/{formTemplateKey}/responses
  • Auth: oAuth2Client (defined in the document in a form this page cannot read)

Path parameters

tenantKeystring hexadecimal required

The unique key for a tenant for whom the form responses belong to.

formTemplateKeystring uuid required

The form template key associated with the form responses.

Response

Form response ids

form_template_keystring uuid required

The form template key associated with the form responses.

Example response

{
  "form_template_key": "2877d684-a340-4e4c-867f-d93283787b01",
  "responses": [
    {
      "form_response_key": "bed773d7902942f29f0b0729390c962c"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.