Get one AdminAgentSessionParticipant

GET

api

sys

adminagentsessionparticipants

{id}

Get one AdminAgentSessionParticipant

curl --request GET \
  --url https://spaces.nexudus.com/api/sys/adminagentsessionparticipants/{id} \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/sys/adminagentsessionparticipants/{id}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/sys/adminagentsessionparticipants/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "AdminAgentSessionId": 123,
  "AdminAgentSessionSessionId": "<string>",
  "AdminAgentSessionTitle": "<string>",
  "UserId": 123,
  "UserFullName": "<string>",
  "UserEmail": "<string>",
  "InvitedById": 123,
  "InvitedByFullName": "<string>",
  "Role": 123,
  "Status": 123,
  "JoinedOn": "<string>",
  "LastReadOn": "<string>",
  "LastDigestOn": "<string>",
  "DigestMuted": true,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

A person taking part in an admin agent conversation

Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the AdminAgentSessionParticipant-Read role.

Path Parameters

integer

required

The Id of the AdminAgentSessionParticipant record to retrieve.

Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/sys/adminagentsessionparticipants/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/adminagentsessionparticipants/87654321',
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const record = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/sys/adminagentsessionparticipants/87654321',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

record = response.json()

Response

200

integer

ID of the admin agent session.

string

Display value for AdminAgentSession.SessionId..

string

Display value for AdminAgentSession.Title..

integer

ID of the person taking part in the conversation.

string

Display value for User.FullName..

string

Display value for User.Email..

integer

User who invited this person (null for the owner).

string

Display value for InvitedBy.FullName..

integer

Owner (started the conversation) or Member (invited).

integer

Active, Left or Removed.

string

UTC time the person joined the conversation.

string

UTC time of the newest message this person has seen; messages after it count as unread.

string

UTC time of the newest message included in the last unread-messages email sent to this person.

boolean

True when this person asked not to receive unread-message emails for this conversation.

integer

Unique record identifier.

string

UUID of the record.

string

Date and time the record was created (ISO 8601).

string

Date and time the record was last updated (ISO 8601).

string

Email of the user who last updated this record.

boolean

Whether the record was recently created.

string

External system identifier.

Example Response

{
  "AdminAgentSessionId": 0,
  "AdminAgentSessionSessionId": null,
  "AdminAgentSessionTitle": null,
  "UserId": 0,
  "UserFullName": null,
  "UserEmail": null,
  "InvitedById": null,
  "InvitedByFullName": null,
  "Role": 0,
  "Status": 0,
  "JoinedOn": "2025-01-15T10:30:00Z",
  "LastReadOn": null,
  "LastDigestOn": null,
  "DigestMuted": false,
  "Id": 87654321,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "CreatedOn": "2025-01-10T08:00:00Z",
  "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "UpdatedBy": "[email protected]",
  "IsNew": false,
  "SystemId": null,
  "ToStringText": "AdminAgentSessionParticipant Example",
  "LocalizationDetails": null,
  "CustomFields": null
}

Get one AdminAgentSessionParticipant

curl --request GET \
  --url https://spaces.nexudus.com/api/sys/adminagentsessionparticipants/{id} \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/sys/adminagentsessionparticipants/{id}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/sys/adminagentsessionparticipants/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "AdminAgentSessionId": 123,
  "AdminAgentSessionSessionId": "<string>",
  "AdminAgentSessionTitle": "<string>",
  "UserId": 123,
  "UserFullName": "<string>",
  "UserEmail": "<string>",
  "InvitedById": 123,
  "InvitedByFullName": "<string>",
  "Role": 123,
  "Status": 123,
  "JoinedOn": "<string>",
  "LastReadOn": "<string>",
  "LastDigestOn": "<string>",
  "DigestMuted": true,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Get one AdminAgentSessionParticipant

Authentication

Path Parameters

Code Examples

Response

200