Retrieve a Participant

View as MarkdownOpen in Claude
Retrieves one active voice-conference participant by the call SID used to join the conference. Use [List all active Participants](/docs/compatibility-api/rest/conference-participants/list-all-participants) to discover Call SIDs; this operation does not retrieve Video Room participants. #### 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](/docs/platform/your-signalwire-api-space).

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 that created this conference.
ConferenceSidstringRequiredformat: "uuid"
The unique identifier for the conference this participant is in.
CallSidstringRequiredformat: "uuid"
The unique identifier for the Participant call connected to this conference.

Response

The request has succeeded.
account_sidstringformat: "uuid"
The unique identifier for the account that created this conference.
call_sidstringformat: "uuid"
The unique identifier for the Participant call connected to this conference.
call_sid_to_coachstring or nullformat: "uuid"
The unique identifier of the participant who is being coached.
coachingboolean
Whether the participant is coaching another call.
conference_sidstringformat: "uuid"
The unique identifier for the conference this participant is in.
date_createdstring
The date, in RFC 2822 format, this conference participant was created.
statusenum
The status of the conference call.
date_updatedstring
The date, in RFC 2822 format, this conference participant was updated.
end_conference_on_exitboolean
Whether or not a conference ends when a participant leaves the conference call.
mutedboolean
Whether or not a participant is muted.
holdboolean
Whether or not a participant is on hold.
start_conference_on_enterboolean
Whether or not a conference will begin when this participant enters the conference call.
uristring
The URI for this conference participant.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error