View source for OperatorAPI pbx:list

''newadmapi (Operator API) function. Available to: '''Operator, SuperRoot'''.''

== Description ==
Lists virtual PBXs (centralitas). Tenant-scoped. The section has INSERT and DELETE but NO UPDATE - the legacy grants no edit group in either tree - and DELETE is withheld: its trigger destroys the extensions, inbound number, dialplan and voicemail boxes of the centralita. Paginated. Sorting and searching are restricted to the declared fields; anything else is rejected and named. Read audience is provisional pending operator confirmation.

== Call ==
 GET|POST https://YOUR_HOST:9089/newadm?func=pbx:list
Send your API key with every request (header <code>X-API-Key: YOUR_KEY</code>, or <code>Authorization: Bearer YOUR_KEY</code>, or the <code>ukey</code> query parameter).

== Parameters ==
None beyond the API key and <code>func=pbx:list</code>.

== Example ==
 <nowiki>https://host:port/newadm?func=pbx:list</nowiki>

== Response ==
Success is <code>{"ok":true,"data":{...}}</code>; on refusal <code>{"ok":false,"code":"...","message":"..."}</code>. This function's data shape: <code>{"ok":true,"data":{"rows":[{"id":n,"accountcode":s,"context":s,"name":s,"fexten":n,"ecount":n,"cli":s,"date":s(ISO-8601, naive)}],"page":n,"pagesize":n,"fields":[s],"available":[s],"order":s,"dir":s,"filterby":s?,"filter":s?}}</code>.

== Errors ==
Refusals carry a machine-readable <code>code</code> (branch on the code, never the message). See [[OperatorAPI#Error codes]].

----
Back to [[OperatorAPI]]
[[Category:OperatorAPI]]