Forms

List a form's submissions

GET/v1/forms/{id}/submissions

Requires an API key with the contacts:read scope. About keys and scopes

Every submission of the form, newest first, with the contact it created or updated as that contact is now; outcome narrows the list. Reading them needs contacts:read, since each names a person.

Path parameters

idstringrequired: uuid

Query parameters

limitintegeroptional

min > 0 · max 100 · default 20

cursorstringoptional

1–2048 characters

outcomestringoptional

Only submissions with this outcome.

one of created, updated, honeypot, pending

Returns

Returns 200 OK. Otherwise returns an error; Errors lists every code and which to retry.

idstringrequired

uuid

formIdstringrequired

uuid

contactIdstring | nullrequired

The contact it created or updated; null when there is none.

uuid

contactEmailstring | nullrequired

The contact as it is now; null when there is none, or it was deleted.

contactNamestring | nullrequired

The contact as it is now; null when there is none, or it was deleted.

outcomestringrequired

What the submission did.

one of created, updated, honeypot, pending

sourcestringrequired

The form's source, recorded on the contact.

createdAtstringrequired

date-time

curl https://api.kirora.io/v1/forms/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/submissions \
  -H "Authorization: Bearer $KIRORA_API_KEY"

const response = await fetch('https://api.kirora.io/v1/forms/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/submissions', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.KIRORA_API_KEY}`,
  },
});
const { data } = await response.json();

import os

import requests

response = requests.get(
    "https://api.kirora.io/v1/forms/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/submissions",
    headers={
        "Authorization": f"Bearer {os.environ['KIRORA_API_KEY']}",
    },
)
data = response.json()["data"]

package main

import (
	"encoding/json"
	"net/http"
	"os"
)

func main() {
	req, err := http.NewRequest("GET", "https://api.kirora.io/v1/forms/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/submissions", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer "+os.Getenv("KIRORA_API_KEY"))

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	var out struct {
		Data json.RawMessage `json:"data"`
	}
	if err := json.NewDecoder(res.Body).Decode(&out); err != nil {
		panic(err)
	}
}

Response · 200

{
  "data": [
    {
      "id": "018f2a4e-6b1c-7d3e-9f40-37386ae05a6b",
      "formId": "018f2a4e-6b1c-7d3e-9f40-b962ee2a5a6b",
      "contactId": "018f2a4e-6b1c-7d3e-9f40-4db757ce5a6b",
      "contactEmail": "contactEmail_example",
      "contactName": "contactName_example",
      "outcome": "created",
      "source": "source_example",
      "createdAt": "2030-03-14T09:30:00Z"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 1,
      "nextCursor": "nextCursor_example"
    }
  }
}

Example values are generated from the schema.