No results

Create an item

Create a new item.

POST https://api.jsonpad.io/lists/{listId}/items

Example

cURL
1234567891011121314151617181920212223curl https://api.jsonpad.io/lists/6797b51c-6d39-424d-b463-ecf0206d162b/items \
  -H "Content-Type: application/json" \
  -H "x-api-token: <YOUR TOKEN>" \
  -d '{
        "data": {
          "name": "John Doe",
          "age": 30,
          "locations": [
            {
              "city": "New York",
              "state": "NY"
            },
            {
              "city": "Los Angeles",
              "state": "CA"
            }
          ]
        },
        "description": "This is a new item",
        "version": "1",
        "readonly": false,
        "activated": true
      }'

Parameters

  • required
    listIdstringA list id or path name.
  • optional
    generatebooleanhttps://api.jsonpad.io/lists/3f119b6f-5f4a-40fb-aca4-da153d0d45e6/items?generate=true

    Whether to generate item data or not. Can be true or false.

    If true, item data will be generated based on the list's prompt and existing items (if any exist). Any data provided in the request body will be merged with the generated data.

  • optional
    includeDatabooleanhttps://api.jsonpad.io/lists/7b6f8df4-9bbf-47c0-8db2-6fec26717949/items?includeData=true

    Whether to include the item data in the response or not. Can be true or false.

    Defaults to true.

Request headers

  • required
    x-api-tokenstringYour API token.
  • optional
    x-identity-tokenstringAn identity token.
  • optional
    x-identity-groupstringAn identity group.

Request body

{
data: {
name: "John Doe"
age: 30
locations: [
0: {
city: "New York"
state: "NY"
}
1: {
city: "Los Angeles"
state: "CA"
}
]
}
description: "This is a test item"
version: "1"
readonly: false
activated: true
}
  • required
    dataanyThe item's data.
  • optional
    descriptionstringA description of the item.
  • optional
    versionstring

    The item's current version.

    By default this will start out as "1" and increment naturally (e.g. "2", "3", and so on), however you can set this to practically any version number format and it will be incremented accordingly.

    Examples
    • "" (empty string) will be incremented to "1".
    • 1 will be incremented to 2.
    • 0.12 will be incremented to 0.13.
    • 0.1.0 will be incremented to 0.1.1.
    • 0.1.0b will be incremented to 0.1.1b.
    • 4test123 will be incremented to 4test124.
  • optional
    readonlybooleanWhether the item is read-only.
  • optional
    activatedbooleanWhether the item is activated. Inactive items are not accessible or usable via the API.

Response body

201 Created
{
id: "22557868-c4c1-4d4f-a03c-a823eb84f866"
createdAt: "2026-09-05T11:29:52.471Z"
updatedAt: "2026-09-05T11:29:52.471Z"
data: {
name: "John Doe"
age: 30
locations: [
0: {
city: "New York"
state: "NY"
}
1: {
city: "Los Angeles"
state: "CA"
}
]
}
description: "Sample item description"
version: "1"
readonly: false
activated: true
size: 12
}

Response headers

  • locationhttps://api.jsonpad.io/lists/15fe0edf-1e4b-4f2e-a6de-7e647afa89c6/items/04d3da13-75a8-4c68-87e0-f89395001573The URL of the newly created item.
  • etagaf2bdbe1aa9b6ec1e2ade1d694f41fc71a831d0268e9891562113d8a62add1bfA SHA-256 hash of the item.
  • last-modified2026-09-05T11:29:52.471ZThe date this item was last modified.
2024-10-29