Skip to Content

TwentyThree™ API

API Method: /api/live/list-formats

Get a list of all valid live event formats.

Parameters

None.

Permission level

The minimum required permission level is:

read

Example XML Response

<response status="ok" permission_level="anonymous" p="1" size="4" total_count="4" cached="1">
    <format key="webinar" name="Webinar"/>
    <format key="investor-relations" name="Investor relations"/>
    <format key="conference" name="Conference"/>
    <format key="internal-meeting" name="Internal meeting"/>
</response>

Example JSON Response

{
  "status": "ok", 
  "permission_level":"anonymous",
  "cached":"1",
  "format":[
    {"key": "webinar", "name": "Webinar"},
    {"key": "investor-relations", "name": "Investor relations"},
    {"key": "conference", "name": "Conference"},
    {"key": "internal-meeting", "name": "Internal meeting"}
  ],
  "p": "1",
  "size": "4",
  "total_count": "4",
  "site": {...},
  "endpoint": "/api/live/list-formats"
}