List Call Memberships

List call memberships.

By default, lists call memberships for all calls in which the authenticated user is an active participant. Viewing all call memberships in your Organization requires an administrator auth token with the spark-admin:call_memberships_read scope.

Use query parameters to filter the response. Results are in descending created order.

Long result sets will be split into pages.

m
You're not logged in. to run the demo.
get
https://api.ciscospark.com/v1/call/memberships

Request Headers

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

Query Parameters

Name Type Description
callStatus string

Limit results to calls with this status.

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

callId string

Limit results to memberships for the specified call.

isHost string

Limit to memberships for calls hosted by the authenticated user.

Possible values: true

personId string

Limit results to memberships belonging to a specific person. Defaults to the authenticated user.

status string

Limit results to memberships with this status.

Possible values: notified, joined, declined, left, waiting

from string

Limit to memberships created from the inclusive start date, in ISO8601 format.

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

to string

Limit to memberships created 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
callStatus string
callId string
isHost string
personId string
status string
from string
to string
max integer

Response Codes

200

OK

400

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

401

Authentication credentials were missing or incorrect.

403

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

404

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.

409

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.

429

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.

500

Something went wrong on the server.

503

Server is overloaded with requests. Try again later.