List Conferences

View as Markdown

A list of Conferences.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Voice or Video.

Learn more about API scopes.

Authentication

AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password. Example: ``` Authorization: Basic base64(project_id:token) ```

Query parameters

include_deletedbooleanOptional
Include logs for deleted activity.
created_onstringOptional

Return logs for activity on this date. Accepts a date (YYYY-MM-DD) or ISO 8601 timestamp.

created_beforestringOptional

Return logs for activity prior to this date. Accepts a date (YYYY-MM-DD) or ISO 8601 timestamp.

created_afterstringOptional

Return logs for activity after this date. Accepts a date (YYYY-MM-DD) or ISO 8601 timestamp.

page_numberintegerOptional>=0Defaults to 0

The page number to retrieve (0-indexed).

page_sizeintegerOptional1-1000Defaults to 50

Specify the number of results to return on a single page. The default page size is 50 and the maximum is 1000.

page_tokenstringOptional

Token for cursor-based pagination. Required when page_number > 0.

Response

The request has succeeded.
datalist of objects
A list of conference logs.

Errors