List Calls

Lists all calls that the authenticated user either initiated or was invited to.

To list currently active calls, use "connected" for the status query parameter; for call history, use "disconnected". Use the from and to parameters to specify a time period. By default, call information is kept for 90 days.

Long result sets will be split into pages.

You're not logged in. to run the demo.

Request Headers

Content-type application/json; charset=utf-8

Query Parameters

Name Type Description
status string

List calls with this state.

Possible values: initializing, lobby, connected, terminating, disconnected

roomId string

List calls placed in the specified room.

isHost string

Limit to calls hosted by the authenticated user.

Possible values: true

from string

Limit to calls that started from the inclusive start date, in ISO8601 format.

Format: yyyy-MM-dd'T'HH:mm:ss.SSSZ

to string

Limit to calls that ended before the exclusive end date, in ISO8601 format.

Format: yyyy-MM-dd'T'HH:mm:ss.SSSZ

max integer

Limit the maximum number of calls in the response.

Query Parameters

Name Type Your values
status string
roomId string
isHost string
from string
to string
max integer

Response Codes




The request was invalid or cannot be otherwise served. An accompanying error message will explain further.


Authentication credentials were missing or incorrect.


The request is understood, but it has been refused or access is not allowed.


The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.


The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.


Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.


Something went wrong on the server.


Server is overloaded with requests. Try again later.