Modules

Retrieve all Module Items from an individual Module

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

Authorization

Path parameters

module*string

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

Response

Request

Retrieve all data about an individual Module Item

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

Authorization

Path parameters

module*string

The Module ID

Example: 1

id*string (id)

The ID of the Module item

Response

Request

Update a Module Item within an individual Module

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

Authorization

Path parameters

module*string

The Module ID

Example: 1

id*string

The Module Item ID

Example: 1

Body

Your Module custom fields as a JSON object

name*string

slugstring

enabled*string

module_field_3_1string

module_field_custom_3_2string

Response

Request

Create a Module Items within an individual Module

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

Authorization

Path parameters

module*string

The Module ID

Example: 1

Body

Your Module custom fields as a JSON object

name*string

slugstring

enabled*string

module_field_3_1string

module_field_custom_3_2string

Response

Request

Retrieve all Module Items from an individual Module

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

Authorization

Path parameters

module*string

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

Response

Request

Retrieve all data about an individual Module Item

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

Authorization

Path parameters

module*string

The Module ID

Example: 1

id*string (id)

The ID of the Module item

Response

Request

Update a Module Item within an individual Module

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

Authorization

Path parameters

module*string

The Module ID

Example: 1

id*string

The Module Item ID

Example: 1

Body

Your Module custom fields as a JSON object

name*string

slugstring

enabled*string

module_field_3_1string

module_field_custom_3_2string

Response

Request

Create a Module Items within an individual Module

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

Authorization

Path parameters

module*string

The Module ID

Example: 1

Body

Your Module custom fields as a JSON object

name*string

slugstring

enabled*string

module_field_3_1string

module_field_custom_3_2string

Response

Request

const response = await fetch('/api/public/site/modules/{module}/items', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

const response = await fetch('/api/public/site/modules/{module}/items/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

const response = await fetch('/api/public/site/modules/{module}/items/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "enabled": "text"
    }),
});
const data = await response.json();

const response = await fetch('/api/public/site/modules/{module}/create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "enabled": "text"
    }),
});
const data = await response.json();