API get documents list
Main Documentation —>
Website —>
API —>
API get documents list
Overview of /admin/getdocs call
The
/admin/getdocs
API call is used to get a list of the pages of documentation.
This is a Private API call and requires an apikey.
Data sent
|
Data
|
Description
|
|
apikey
|
The API Key from the /account/login API
|
Data returned
|
Data
|
Description
|
|
success
|
This value indicates whether or not the call succeeded. A value of "false" indicates that there will be no other data.
|
|
docs
|
array of
docList objects
|
docList Object
|
Data
|
Description
|
|
key
|
This is the key that must be used to retrieve the document
|
|
title
|
This is the title of the document
|
Notes
None.
Failures
{"success":false,"error":"Missing required parameter - apikey"}
Back
