Spike Labs API

Public Forms

Endpointhttps://api.spikelabs.com

Get a published form by key or ID

GET

https://api.spikelabs.com

/form/api/forms/{keyOrId}

Fetches a published form by key (string) or form ID (UUID) for rendering the UI. Only returns published, non-deleted forms.

Get a published form by key or ID › path Parameters

keyOrId

string · required

Get a published form by key or ID › Responses

Published form with groups and fields

id

string · uuid · required

title

string · required

description

string | null · required

key

string · required

version

integer · required

object | null · required

object[] · required

object[]

style

object | null

GET/form/api/forms/{keyOrId}

curl --request GET \
  --url https://api.spikelabs.com/form/api/forms/:keyOrId

shell

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "title": "title",
  "description": {},
  "key": "key",
  "version": 0,
  "settings": {},
  "groups": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "position": 0,
      "title": {},
      "subtitle": {},
      "fields": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "position": 0,
          "fieldType": "text_input",
          "label": {},
          "labelVariants": {},
          "config": {},
          "isRequired": true,
          "key": {}
        }
      ]
    }
  ],
  "intermediates": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "beforeGroupId": "00000000-0000-0000-0000-000000000000",
      "afterGroupId": "00000000-0000-0000-0000-000000000000",
      "position": 0,
      "title": {},
      "backgroundImage": {},
      "buttonText": {},
      "visibilityCondition": {},
      "blocks": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "intermediateId": "00000000-0000-0000-0000-000000000000",
          "parentBlockId": "00000000-0000-0000-0000-000000000000",
          "position": 0,
          "blockType": "text",
          "config": {},
          "children": [
            {
              "id": "00000000-0000-0000-0000-000000000000",
              "intermediateId": "00000000-0000-0000-0000-000000000000",
              "parentBlockId": "00000000-0000-0000-0000-000000000000",
              "position": 0,
              "blockType": "text",
              "config": {},
              "children": [
                {
                  "id": "00000000-0000-0000-0000-000000000000",
                  "intermediateId": "00000000-0000-0000-0000-000000000000",
                  "parentBlockId": "00000000-0000-0000-0000-000000000000",
                  "position": 0,
                  "blockType": "text",
                  "config": {},
                  "children": [
                    {
                      "id": "00000000-0000-0000-0000-000000000000",
                      "intermediateId": "00000000-0000-0000-0000-000000000000",
                      "parentBlockId": "00000000-0000-0000-0000-000000000000",
                      "position": 0,
                      "blockType": "text",
                      "config": {},
                      "children": [
                        {
                          "id": "00000000-0000-0000-0000-000000000000",
                          "intermediateId": "00000000-0000-0000-0000-000000000000",
                          "parentBlockId": "00000000-0000-0000-0000-000000000000",
                          "position": 0,
                          "blockType": "text",
                          "config": {},
                          "children": [
                            {}
                          ]
                        }
                      ]
                    }
                  ]
                }
              ]
            }
          ]
        }
      ]
    }
  ],
  "style": {}
}

json

application/json

Submit form responses

POST

https://api.spikelabs.com

/form/api/forms/{key}/submit

Validates and stores form responses. Requires X-User-Id header.

Submit form responses › path Parameters

key

string · required

Submit form responses › Request Body

object[] · required

object

Submit form responses › Responses

Submission successful

success

boolean · enum · required

Enum values:

object · required

POST/form/api/forms/{key}/submit

curl --request POST \
  --url https://api.spikelabs.com/form/api/forms/:key/submit \
  --header 'Content-Type: application/json' \
  --data '
{
  "responses": [
    {
      "fieldId": "00000000-0000-0000-0000-000000000000",
      "responseValue": {}
    }
  ],
  "metadata": {
    "deviceType": "mobile",
    "userAgent": "userAgent",
    "timeSpentSeconds": 0,
    "startedAt": "startedAt"
  }
}
'

shell

Example Request Body

{
  "responses": [
    {
      "fieldId": "00000000-0000-0000-0000-000000000000",
      "responseValue": {}
    }
  ],
  "metadata": {
    "deviceType": "mobile",
    "userAgent": "userAgent",
    "timeSpentSeconds": 0,
    "startedAt": "startedAt"
  }
}

json

Example Responses

{
  "success": true,
  "data": {
    "submissionId": "00000000-0000-0000-0000-000000000000"
  }
}

json

application/json

Save or update a draft submission

PUT

https://api.spikelabs.com

/form/api/forms/{key}/draft

Creates a new draft or updates an existing one. Requires X-User-Id header.

Save or update a draft submission › path Parameters

key

string · required

Save or update a draft submission › Request Body

object[] · required

object

Save or update a draft submission › Responses

Draft saved successfully

submissionId

string · uuid · required

status

string · enum · required

Enum values:

draft

PUT/form/api/forms/{key}/draft

curl --request PUT \
  --url https://api.spikelabs.com/form/api/forms/:key/draft \
  --header 'Content-Type: application/json' \
  --data '
{
  "responses": [
    {
      "fieldId": "00000000-0000-0000-0000-000000000000",
      "responseValue": {}
    }
  ],
  "metadata": {
    "deviceType": "mobile",
    "userAgent": "userAgent",
    "timeSpentSeconds": 0,
    "startedAt": "startedAt"
  }
}
'

shell

Example Request Body

{
  "responses": [
    {
      "fieldId": "00000000-0000-0000-0000-000000000000",
      "responseValue": {}
    }
  ],
  "metadata": {
    "deviceType": "mobile",
    "userAgent": "userAgent",
    "timeSpentSeconds": 0,
    "startedAt": "startedAt"
  }
}

json

Example Responses

{
  "submissionId": "00000000-0000-0000-0000-000000000000",
  "status": "draft"
}

json

application/json

Get user's submission for a form

GET

https://api.spikelabs.com

/form/api/forms/{key}/submission

Returns the user's draft or submitted response. Requires X-User-Id header.

Get user's submission for a form › path Parameters

key

string · required

Get user's submission for a form › Responses

User's submission

submissionId

string · uuid · required

status

string · enum · required

Enum values:

draft

submitted

reviewed

submittedAt

string | null · date-time · required

object[] · required

object · required

GET/form/api/forms/{key}/submission

curl --request GET \
  --url https://api.spikelabs.com/form/api/forms/:key/submission

shell

Example Responses

{
  "submissionId": "00000000-0000-0000-0000-000000000000",
  "status": "draft",
  "submittedAt": "2024-08-25T15:00:00Z",
  "responses": [
    {
      "fieldId": "00000000-0000-0000-0000-000000000000",
      "responseValue": {}
    }
  ],
  "metadata": {
    "deviceType": "mobile",
    "userAgent": "userAgent",
    "timeSpentSeconds": 0,
    "startedAt": "startedAt"
  }
}

json

application/json

user Other endpoints

Get a published form by key or ID

GET

https://api.spikelabs.com

/form/api/forms/{keyOrId}

Fetches a published form by key (string) or form ID (UUID) for rendering the UI. Only returns published, non-deleted forms.

Get a published form by key or ID › path Parameters

keyOrId

string · required

Get a published form by key or ID › Responses

Published form with groups and fields

id

string · uuid · required

title

string · required

description

string | null · required

key

string · required

version

integer · required

object | null · required

object[] · required

object[]

style

object | null

{ "id": "00000000-0000-0000-0000-000000000000", "title": "title", "description": {}, "key": "key", "version": 0, "settings": {}, "groups": [ { "id": "00000000-0000-0000-0000-000000000000", "position": 0, "title": {}, "subtitle": {}, "fields": [ { "id": "00000000-0000-0000-0000-000000000000", "position": 0, "fieldType": "text_input", "label": {}, "labelVariants": {}, "config": {}, "isRequired": true, "key": {} } ] } ], "intermediates": [ { "id": "00000000-0000-0000-0000-000000000000", "beforeGroupId": "00000000-0000-0000-0000-000000000000", "afterGroupId": "00000000-0000-0000-0000-000000000000", "position": 0, "title": {}, "backgroundImage": {}, "buttonText": {}, "visibilityCondition": {}, "blocks": [ { "id": "00000000-0000-0000-0000-000000000000", "intermediateId": "00000000-0000-0000-0000-000000000000", "parentBlockId": "00000000-0000-0000-0000-000000000000", "position": 0, "blockType": "text", "config": {}, "children": [ { "id": "00000000-0000-0000-0000-000000000000", "intermediateId": "00000000-0000-0000-0000-000000000000", "parentBlockId": "00000000-0000-0000-0000-000000000000", "position": 0, "blockType": "text", "config": {}, "children": [ { "id": "00000000-0000-0000-0000-000000000000", "intermediateId": "00000000-0000-0000-0000-000000000000", "parentBlockId": "00000000-0000-0000-0000-000000000000", "position": 0, "blockType": "text", "config": {}, "children": [ { "id": "00000000-0000-0000-0000-000000000000", "intermediateId": "00000000-0000-0000-0000-000000000000", "parentBlockId": "00000000-0000-0000-0000-000000000000", "position": 0, "blockType": "text", "config": {}, "children": [ { "id": "00000000-0000-0000-0000-000000000000", "intermediateId": "00000000-0000-0000-0000-000000000000", "parentBlockId": "00000000-0000-0000-0000-000000000000", "position": 0, "blockType": "text", "config": {}, "children": [ {} ] } ] } ] } ] } ] } ] } ], "style": {} }

Submit form responses

POST

https://api.spikelabs.com

/form/api/forms/{key}/submit

Validates and stores form responses. Requires X-User-Id header.

Submit form responses › path Parameters

key

string · required

Submit form responses › Request Body

object[] · required

object

Submit form responses › Responses

Submission successful

success

boolean · enum · required

Enum values:

object · required

curl --request POST \ --url https://api.spikelabs.com/form/api/forms/:key/submit \ --header 'Content-Type: application/json' \ --data ' { "responses": [ { "fieldId": "00000000-0000-0000-0000-000000000000", "responseValue": {} } ], "metadata": { "deviceType": "mobile", "userAgent": "userAgent", "timeSpentSeconds": 0, "startedAt": "startedAt" } } '

{ "responses": [ { "fieldId": "00000000-0000-0000-0000-000000000000", "responseValue": {} } ], "metadata": { "deviceType": "mobile", "userAgent": "userAgent", "timeSpentSeconds": 0, "startedAt": "startedAt" } }

Save or update a draft submission

PUT

https://api.spikelabs.com

/form/api/forms/{key}/draft

Creates a new draft or updates an existing one. Requires X-User-Id header.

Save or update a draft submission › path Parameters

key

string · required

Save or update a draft submission › Request Body

object[] · required

object

Save or update a draft submission › Responses

Draft saved successfully

submissionId

string · uuid · required

status

string · enum · required

Enum values:

draft

curl --request PUT \ --url https://api.spikelabs.com/form/api/forms/:key/draft \ --header 'Content-Type: application/json' \ --data ' { "responses": [ { "fieldId": "00000000-0000-0000-0000-000000000000", "responseValue": {} } ], "metadata": { "deviceType": "mobile", "userAgent": "userAgent", "timeSpentSeconds": 0, "startedAt": "startedAt" } } '

Get user's submission for a form

GET

https://api.spikelabs.com

/form/api/forms/{key}/submission

Returns the user's draft or submitted response. Requires X-User-Id header.

Get user's submission for a form › path Parameters

key

string · required

Get user's submission for a form › Responses

User's submission

submissionId

string · uuid · required

status

string · enum · required

Enum values:

draft

submitted

reviewed

submittedAt

string | null · date-time · required

object[] · required

object · required