🔗Modules

Retrieve all Module Items from an individual Module

get

/api/public/site/modules/{module}/items

Authorizations

SessionKeySiteID

Path parameters

modulestringrequired

The Module ID

Example: 1

Query parameters

itemsid · array

A comma seperated list of item IDs to retrieve, leave empty to get all items

propertiesstring · array

A comma seperated list of properties that you would like to retrieve, leave empty to get all properties

Example: name,slug,enabled

per_pageinteger

Number of items to retireve, maximum of 500

Example: 20

sort_typestring

Property by which to sort the results

Example: created_at

sort_orderstring

Order of results (asc or desc)

Example: desc

pageint

Page to retrieve number, to be used with per_page

Example: 1

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/public/site/modules/{module}/items' \
  --header 'authorization: YOUR_API_KEY'

200

401

403

404

422

200

No body

OK

Retrieve all data about an individual Module Item

get

/api/public/site/modules/{module}/items/{id}

Authorizations

SessionKeySiteID

Path parameters

modulestringrequired

The Module ID

Example: 1

idstring · idrequired

The ID of the Module item

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/public/site/modules/{module}/items/{id}' \
  --header 'authorization: YOUR_API_KEY'

200

401

403

404

422

200

No body

OK

Update a Module Item within an individual Module

put

/api/public/site/modules/{module}/items/{id}

Authorizations

SessionKeySiteID

Path parameters

modulestringrequired

The Module ID

Example: 1

idstringrequired

The Module Item ID

Example: 1

Body

namestringrequired

slugstring

enabledstringrequired

module_field_3_1string

module_field_custom_3_2string

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/public/site/modules/{module}/items/{id}' \
  --header 'authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "slug": "text",
    "enabled": "text",
    "module_field_3_1": "text",
    "module_field_custom_3_2": "text"
  }'

200

401

403

422

200

No body

OK

Create a Module Items within an individual Module

post

/api/public/site/modules/{module}/create

Authorizations

SessionKeySiteID

Path parameters

modulestringrequired

The Module ID

Example: 1

Body

namestringrequired

slugstring

enabledstringrequired

module_field_3_1string

module_field_custom_3_2string

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/public/site/modules/{module}/create' \
  --header 'authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "slug": "text",
    "enabled": "text",
    "module_field_3_1": "text",
    "module_field_custom_3_2": "text"
  }'

200

401

403

422

200

No body

OK