Modules

Retrieve all Module Items from an individual Module

get

Authorizations

Path parameters

modulestringRequired

The Module ID

Example: 1

Query parameters

itemsid · arrayOptional

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

propertiesstring · arrayOptional

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

Example: name,slug,enabled

per_pageintegerOptional

Number of items to retireve, maximum of 500

Example: 20

sort_typestringOptional

Property by which to sort the results

Example: created_at

sort_orderstringOptional

Order of results (asc or desc)

Example: desc

pageintOptional

Page to retrieve number, to be used with per_page

Example: 1

Responses

200

401

Unauthorized - Credentials Incorrect

403

Forbidden - You cannot access this site

404

Not Found - Module does not exist or contains no Items

422

Unprocessable Entity - Required data missing or data invalid

get

GET /api/site/v2/modules/{module}/items HTTP/1.1
Host: {{your site}}
x-api-key: YOUR_API_KEY
Accept: */*

No content

Retrieve all data about an individual Module Item

get

Authorizations

Path parameters

modulestringRequired

The Module ID

Example: 1

idstring · idRequired

The ID of the Module item

Responses

200

401

Unauthorized - Credentials Incorrect

403

Forbidden - You cannot access this site

404

Not Found - Module Item does not exist

422

Unprocessable Entity - Required data missing or data invalid

get

GET /api/site/v2/modules/{module}/items/{id} HTTP/1.1
Host: {{your site}}
x-api-key: YOUR_API_KEY
Accept: */*

No content

Update a Module Item within an individual Module

put

Authorizations

Path parameters

modulestringRequired

The Module ID

Example: 1

idstringRequired

The Module Item ID

Example: 1

Body

namestringRequired

slugstringOptional

enabledstringRequired

module_field_3_1stringOptional

module_field_custom_3_2stringOptional

Responses

200

401

Unauthorized - Credentials Incorrect

403

Forbidden - You cannot access this site

422

Unprocessable Entity - Required data missing or data invalid

put

PUT /api/site/v2/modules/{module}/items/{id} HTTP/1.1
Host: {{your site}}
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 105

{
  "name": "text",
  "slug": "text",
  "enabled": "text",
  "module_field_3_1": "text",
  "module_field_custom_3_2": "text"
}

No content

Create a Module Items within an individual Module

post

Authorizations

Path parameters

modulestringRequired

The Module ID

Example: 1

Body

namestringRequired

slugstringOptional

enabledstringRequired

module_field_3_1stringOptional

module_field_custom_3_2stringOptional

Responses

200

401

Unauthorized - Credentials Incorrect

403

Forbidden - You cannot access this site

422

Unprocessable Entity - Required data missing or data invalid

post

POST /api/site/v2/modules/{module}/create HTTP/1.1
Host: {{your site}}
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 105

{
  "name": "text",
  "slug": "text",
  "enabled": "text",
  "module_field_3_1": "text",
  "module_field_custom_3_2": "text"
}

No content

PreviousCategories NextWebApps

Last updated 2 months ago

Was this helpful?

PUT /api/site/v2/modules/{module}/items/{id} HTTP/1.1 Host: {{your site}} x-api-key: YOUR_API_KEY Content-Type: application/json Accept: */* Content-Length: 105 { "name": "text", "slug": "text", "enabled": "text", "module_field_3_1": "text", "module_field_custom_3_2": "text" }

POST /api/site/v2/modules/{module}/create HTTP/1.1 Host: {{your site}} x-api-key: YOUR_API_KEY Content-Type: application/json Accept: */* Content-Length: 105 { "name": "text", "slug": "text", "enabled": "text", "module_field_3_1": "text", "module_field_custom_3_2": "text" }