Skip to main content
POST
/
v3
/
lists
/
definitions
Add List Definition
curl --request POST \
  --url http://localhost/api/v3/lists/definitions \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "handle": "<string>",
  "type": "<string>",
  "icon": "<string>",
  "cover": "<string>",
  "timezone": "<string>",
  "reservation_period": 123,
  "reservation_period_type": "days",
  "reservation_absolute_expiry": "<string>",
  "reservation_reserved_target_id": 123,
  "reservation_notify_reserved_offset_days": 123,
  "reservation_notify_reserved_offset_hours": 123,
  "reservation_expiry_target_id": 123,
  "reservation_remind_target_id": 123,
  "reservation_notify_remind_offset_days": 123,
  "reservation_notify_remind_offset_hours": 123,
  "meta": [
    "<string>"
  ],
  "short_description": "<string>",
  "description": "<string>",
  "allow_share": true,
  "allow_quantity": true,
  "allow_reserve": true,
  "allow_custom_product": true,
  "is_published": true,
  "is_active": true,
  "allow_edit": true,
  "allow_new": true,
  "allow_delete": true,
  "organisation_id": 123,
  "tags": [
    "<string>"
  ]
}
'
{
  "data": {
    "id": 123,
    "name": "<string>",
    "handle": "<string>",
    "type": "<string>",
    "icon": "<string>",
    "cover": "<string>",
    "short_description": "<string>",
    "description": "<string>",
    "allow_share": true,
    "allow_quantity": true,
    "allow_reserve": true,
    "allow_custom_product": true,
    "timezone": "<string>",
    "reservation_period": 123,
    "reservation_period_type": "<string>",
    "reservation_absolute_expiry": "<string>",
    "reservation_reserved_target_id": 123,
    "reservation_notify_reserved_offset_days": 123,
    "reservation_notify_reserved_offset_hours": 123,
    "reservation_expiry_target_id": 123,
    "reservation_remind_target_id": 123,
    "reservation_notify_remind_offset_days": 123,
    "reservation_notify_remind_offset_hours": 123,
    "meta": [
      "<unknown>"
    ],
    "is_published": true,
    "is_active": true,
    "allow_edit": true,
    "allow_new": true,
    "allow_delete": true,
    "tags": [
      "<string>"
    ],
    "organisation": {
      "id": 123,
      "name": "<string>",
      "handle": "<string>",
      "description": "<string>",
      "short_description": "<string>",
      "icon": "<string>",
      "image_url": "<string>",
      "notes": "<string>",
      "type": "<string>",
      "status": "<string>",
      "is_tenant": 123,
      "is_active": 123,
      "phone": "<string>",
      "email": "<string>",
      "secondary_phone": "<string>",
      "domain": "<string>",
      "authorised_domains": [
        "<unknown>"
      ],
      "meta": [
        "<unknown>"
      ],
      "locations": [
        {
          "id": 123,
          "type": "<string>",
          "name": "<string>",
          "handle": "<string>",
          "description": "<string>",
          "phone": "<string>",
          "email": "<string>",
          "timezone": "<string>",
          "external_id": "<string>",
          "external_code": "<string>",
          "is_published": true,
          "is_permanently_closed": true,
          "address": {
            "id": 123,
            "address_line_1": "<string>",
            "address_line_2": "<string>",
            "address_line_3": "<string>",
            "company": "<string>",
            "latitude": 123,
            "longitude": 123,
            "city": "<string>",
            "postcode": "<string>",
            "state": "<string>",
            "country": "<string>",
            "notes": "<string>",
            "external_id": "<string>",
            "is_default": true,
            "created_at": "<string>",
            "updated_at": "<string>",
            "meta": [
              "<unknown>"
            ],
            "name": "<string>",
            "type": "<string>",
            "phone": "<string>",
            "iso": "<string>",
            "iso_state": "<string>",
            "profile_id": "<string>",
            "custom_fields": {}
          },
          "normal_hours": [
            [
              "<unknown>"
            ]
          ],
          "special_hours": [
            [
              "<unknown>"
            ]
          ],
          "tags": [
            "<string>"
          ],
          "custom_fields": {},
          "icon": "<string>",
          "country_iso_3": "<string>",
          "image_url": "<string>",
          "created_at": "<string>",
          "updated_at": "<string>",
          "departments": [
            {
              "id": 123,
              "name": "<string>",
              "handle": "<string>",
              "external_id": "<string>",
              "external_code": "<string>",
              "description": "<string>",
              "short_description": "<string>",
              "url": "<string>",
              "image_url": "<string>",
              "internal_note": "<string>",
              "meta": [
                "<unknown>"
              ],
              "brand_id": 123,
              "location_id": 123,
              "brand": {
                "name": "<string>",
                "handle": "<string>"
              },
              "created_at": "<string>",
              "updated_at": "<string>"
            }
          ]
        }
      ],
      "address": {
        "id": 123,
        "address_line_1": "<string>",
        "address_line_2": "<string>",
        "address_line_3": "<string>",
        "company": "<string>",
        "latitude": 123,
        "longitude": 123,
        "city": "<string>",
        "postcode": "<string>",
        "state": "<string>",
        "country": "<string>",
        "notes": "<string>",
        "external_id": "<string>",
        "is_default": true,
        "created_at": "<string>",
        "updated_at": "<string>",
        "meta": [
          "<unknown>"
        ],
        "name": "<string>",
        "type": "<string>",
        "phone": "<string>",
        "iso": "<string>",
        "iso_state": "<string>",
        "profile_id": "<string>",
        "custom_fields": {}
      },
      "custom_fields": {},
      "created_at": "<string>",
      "updated_at": "<string>"
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.omneo.io/llms.txt

Use this file to discover all available pages before exploring further.

Body

application/json
name
string
required
handle
string
required
type
string
required
icon
string<uri> | null
cover
string<uri> | null
timezone
string
reservation_period
integer
reservation_period_type
enum<string>
Available options:
days,
weeks,
months,
years,
absolute_date,
absolute_week,
absolute_month
reservation_absolute_expiry
string | null
reservation_reserved_target_id
integer | null
reservation_notify_reserved_offset_days
integer | null
reservation_notify_reserved_offset_hours
integer | null
reservation_expiry_target_id
integer | null
reservation_remind_target_id
integer | null
reservation_notify_remind_offset_days
integer | null
reservation_notify_remind_offset_hours
integer | null
meta
string[] | null
short_description
string | null
description
string | null
allow_share
boolean | null
allow_quantity
boolean | null
allow_reserve
boolean | null
allow_custom_product
boolean | null
is_published
boolean | null
is_active
boolean | null
allow_edit
boolean | null
allow_new
boolean | null
allow_delete
boolean | null
organisation_id
integer | null
tags
string[]

Response

ListDefinition

data
ListDefinition · object
required