Skip to main content
GET
/
online_conferences
List Online Conferences
curl --request GET \
  --url https://{primary_domain}/api/public/v2.0/online_conferences \
  --header 'X-Access-Key-Id: <api-key>' \
  --header 'X-Access-Key-Secret: <api-key>'
{
  "message": "<string>",
  "data": [
    {
      "id": 123,
      "online_conference_account_id": 123,
      "public_id": "<string>",
      "title": "<string>",
      "is_public": true,
      "deleted_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "backer_event_id": 123,
      "is_occurred": true,
      "started_at": "2023-11-07T05:31:56Z",
      "ended_at": "2023-11-07T05:31:56Z"
    }
  ],
  "current_page": 123,
  "first_page_url": "<string>",
  "from": 123,
  "last_page": 123,
  "last_page_url": "<string>",
  "next_page_url": "<string>",
  "path": "<string>",
  "per_page": 123,
  "prev_page_url": "<string>",
  "to": 123,
  "total": 123
}

Authorizations

​
X-Access-Key-Id
string
header
required
​
X-Access-Key-Secret
string
header
required

Query Parameters

​
owner_id
integer

Resource Object ID of owner. Required if "owner_type" is defined.

​
owner_type
enum<string>

Resource Object Type of owner. Required if "owner_id" is defined.

Available options:
App\Models\Tenant\User,
App\Models\Tenant\Department
​
page_size
integer

Maximum number of items in a page.

​
page
integer

Page number of query.

​
with_trashed
boolean

Whether or not deleted items are included.

​
order_by
enum<string>

Attribute to order query by.

Available options:
id,
public_id,
title,
is_public,
is_occurred,
started_at,
ended_at,
created_at,
updated_at,
deleted_at
​
order_direction
enum<string>

Direction to order query by.

Available options:
asc,
desc
​
value
string

Value of attribute to filter query by.

​
operator
enum<string>

Comparison operator to filter query by.

Available options:
Equal,
NotEqual,
Contains,
GreaterThan,
GreaterThanOrEqual,
LessThan,
LessThanOrEqual,
IsNull,
NotNull
​
on
enum<string>

Attribute to filter query by

Available options:
id,
public_id,
title,
is_public,
is_occurred,
started_at,
ended_at,
created_at,
updated_at,
deleted_at

Response

​
message
string
required
​
data
object[]
required

A list of Online Conference resource objects.

​
current_page
integer
required

Current page number.

​
first_page_url
string
required

URL to fetch the first page.

​
from
integer | null
required
​
last_page
integer
required

Last page number.

​
last_page_url
string
required

URL to fetch the last page.

​
next_page_url
string | null
required

URL to fetch the next page.

​
path
string
required

Current URL.

​
per_page
integer
required

Number of items per page.

​
prev_page_url
string | null
required

URL to fetch the next page.

​
to
integer | null
required
​
total
integer
required

Total number of items.