api:helpcenter:list
Table of Contents
API : HelpCenters
Introduction
Returns a list of Help centers.
Request
| URL | https://api.telecomx.dk/helpcenter/helpcenter | |
|---|---|---|
| Method | GET | |
| Access Level | RESELLER_ADMIN OR ADMIN | |
Query Example
https://api.telecomx.dk/helpcenter/helpcenter
Response
| JSON (HelpCenterSettings) object | ||
|---|---|---|
| _id | String | Id of the customer this Helpcenter belongs to. |
| helpCenters | Array of objects | Settings for helpcenters for customer. |
| helpCenters[].id | String | Id of the helpcenter. |
| helpCenters[].name | String | Name of specific Helpcenter. |
Example
{ _id: ObjectId('1234578901234567890ABCD'), name: 'FupFirma', helpCenters: [ { id: ObjectId('1234578901234567890ABCD'), name: 'FupFirma 1', }, { ... } ] }
Errors
| Error code | Message | Description |
|---|---|---|
| 403 | access_denied | Insufficient access level |
| 404 | not_found | Failed to find resource |
| 500 | internal_error | <Unspecified error> |
api/helpcenter/list.txt · Last modified: 2025/02/13 14:12 by Per Møller