Module
  • 16 Jun 2022
  • 1 Minute to read
  • Dark
    Light

Module

  • Dark
    Light

Article Summary

Module

Module JSON Format

Module is represented as simple flat JSON objects with the following keys:

NameTypeDescription
idstringId of module.
namestringName of module.
descriptionstringDescription of module.
orderintegerOrder of module.

Get the list of Modules

GET global/modules

  • Parameters:

No Parameters

  • Response:

An array of Module

  • Example

Sample Request:

curl https://api11.comm100.io/v4/global/modules \ 
    -X 'GET' \ 
    -H 'Authorization: Bearer {access_token}' \ 

Response:

HTTP/1.1 200 OK

[
  {
      "id": "",
      "name": "LiveChat",
      "description": "This is LiveChat.",
      "order": 0
  }
] 

Get a single Module

GET global/modules/{id}

  • Parameters:

No Parameters

  • Response:

Module

  • Example

Sample Request:

curl https://api11.comm100.io/v4/global/modules/ \ 
    -X 'GET' \ 
    -H 'Authorization: Bearer {access_token}' \ 

Response:

HTTP/1.1 200 OK

{
  "id": "",
  "name": "LiveChat",
  "description": "This is LiveChat.",
  "order": 0
} 

Was this article helpful?