Skip to navigation
Compatibility REST APIQueue Members

Retrieve a Queue Member

View as MarkdownOpen in Claude

Retrieves one waiting caller by Call SID, or the caller at the front of the queue when Front is used. Use List All Queue Members to inspect the full waiting order. The native API reads the same waiting calls by member ID, with Get next queue member in place of the Front selector.

Permissions

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

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)

Path parameters

AccountSidstringRequiredformat: "uuid"
The unique identifier for the account this Queue is associated with.
QueueSidstringRequiredformat: "uuid"
The unique identifier for the queue.
CallSidstringRequired
The unique identifier for the call, or the special value 'Front' to reference the member at the front of the queue.

Response

The request has succeeded.
call_sidstringformat: "uuid"
The unique identifier for the call.
account_sidstringformat: "uuid"
The unique identifier for the account.
queue_sidstringformat: "uuid"
The unique identifier for the queue.
date_enqueuedstring
The date and time, in RFC 2822 format, when the member was enqueued.
positioninteger>=1

The position of the member in the queue (1-indexed).

wait_timeinteger>=0
The wait time, in seconds, since the member was enqueued.
member_typestring
The type of the queue member.
uristring
The URI of this resource, relative to the API base URL.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error