Module

Prev Next

Module

Module JSON Format

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

Name Type Description
id string Id of module.
name string Name of module.
description string Description of module.
order integer Order 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
} 
Copyright © 2022 Comm100 Network Corporation. All Rights Reserved.