Get a form

GET/forms/{id}

Authorization

AuthorizationBearer token (JWT) · headerrequired

Path parameters

idstringrequired

Form ID or slug

Responses

200

Form entity

_linksHalLinks

idinteger

shop_idinteger

titlestring

slugstring

bodystring

descriptionstring

visibleboolean

formatstring

has_address_fieldsboolean

success_messagestring

created_onstring<date-time>

updated_onstring<date-time>

404

Form not found

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (JWT)Remember on this deviceInclude my values in samples

Parameters

idpath*Form ID or slug

Request

curl -X GET 'https://api.onbolder.com/v2/forms/string' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'

const response = await fetch("https://api.onbolder.com/v2/forms/string", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json"
  }
});

import requests

response = requests.get(
    "https://api.onbolder.com/v2/forms/string",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json"
    },
)

Response

{
  "_links": {
    "property1": {
      "href": "string",
      "templated": true,
      "method": "get",
      "title": "string",
      "type": "string"
    },
    "property2": {
      "href": "string",
      "templated": true,
      "method": "get",
      "title": "string",
      "type": "string"
    }
  },
  "id": 0,
  "shop_id": 0,
  "title": "string",
  "slug": "string",
  "body": "string",
  "description": "string",
  "visible": true,
  "format": "string",
  "has_address_fields": true,
  "success_message": "string",
  "created_on": "2019-08-24T14:15:22Z",
  "updated_on": "2019-08-24T14:15:22Z"
}