API Guide / API Reference / Metadata API / Module
Module

Use this API to get the list of available modules. If this request is successful, the server returns a response body that contains the module information. 

The returned response will contain the important field called ‘API Name’, which represents the Module name when call APIs.


URL

https://Witly.co/api/v2/module?token={0}[&format={1}]


HTTP Method

GET


Request Body

Not required


Request Parameters

Parameter

Required

Description

token

Yes

Access token

format

Optional

Expected return format. The default is JSON. Values are JSON and XML. This parameter is optional.


Example Request

https://Witly.co/api/v2/module?token=5c33446ac1c049049f9232cf296bdf10


Example Response

[

{

"Name""Customer",

"API Name""customer",     

"Type""Main",

"accessible""false",

"creatable""false",

"editable""false",

"deletable""false",

"Icon Url""http://Witly.co/res/customer/images/

module-icons/a02bd462-8a9c-4ea5-b438-402d1017dd3b_48px.png",

"Url""/module/customer/home"

},

{

"Name""Contact",

"API Name""contact",

"Type""Main",

"accessible""false",

"creatable""false",

"editable""false",

"deletable""false",

"Icon Url""http://Witly.co/theme/common/images/blank.gif",

"Url""/module/contact/home"

},

...........


Last modified on Jan 23, 2018