Search AdminAgentSessionParticipants

GET

api

sys

adminagentsessionparticipants

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

import requests

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

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', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

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-List role.

Query Parameters

Pagination & Sorting

integer

default:"1"

The page number to retrieve.

integer

default:"25"

The number of records per page.

string

The property name to sort results by (e.g. Name, CreatedOn).

integer

Sort direction. 0 for ascending, 1 for descending.

Filters

integer

Filter by iD of the admin agent session.

string

Filter by display value for AdminAgentSession.SessionId..

string

Filter by display value for AdminAgentSession.Title..

integer

Filter by iD of the person taking part in the conversation.

string

Filter by display value for User.FullName..

string

Filter by display value for User.Email..

integer

Filter by user who invited this person (null for the owner).

string

Filter by display value for InvitedBy.FullName..

integer

Filter by owner (started the conversation) or Member (invited).

integer

Filter by active, Left or Removed.

string

Filter by uTC time the person joined the conversation.

string

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

string

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

boolean

Filter by true when this person asked not to receive unread-message emails for this conversation.

Range Filters

string

Filter by uTC time the person joined the conversation greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by uTC time the person joined the conversation less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by uTC time of the newest message this person has seen; messages after it count as unread greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by uTC time of the newest message this person has seen; messages after it count as unread less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by uTC time of the newest message included in the last unread-messages email sent to this person greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by uTC time of the newest message included in the last unread-messages email sent to this person less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records updated on or before this date. Format: YYYY-MM-DDTHH:mm.

Code Examples

Simple listing

curl -X GET \
  "https://spaces.nexudus.com/api/sys/adminagentsessionparticipants?page=1&size=15&orderBy=CreatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/adminagentsessionparticipants?' + new URLSearchParams({
    page: 1,
    size: 15,
    orderBy: 'CreatedOn',
    dir: 1 // Ascending
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/sys/adminagentsessionparticipants',
    params={
        'page': 1,
        'size': 15,
        'orderBy': 'CreatedOn',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Filtering by CreatedOn

curl -X GET \
  "https://spaces.nexudus.com/api/sys/adminagentsessionparticipants?AdminAgentSessionParticipant_CreatedOn=example-value&orderBy=CreatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/adminagentsessionparticipants?' + new URLSearchParams({
    AdminAgentSessionParticipant_CreatedOn: 'example-value',
    orderBy: 'CreatedOn',
    dir: 1
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/sys/adminagentsessionparticipants',
    params={
        'AdminAgentSessionParticipant_CreatedOn': 'example-value',
        'orderBy': 'CreatedOn',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Range filters

curl -X GET \
  "https://spaces.nexudus.com/api/sys/adminagentsessionparticipants?from_AdminAgentSessionParticipant_UpdatedOn=2025-01-01T00:00&to_AdminAgentSessionParticipant_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/adminagentsessionparticipants?' + new URLSearchParams({
    from_AdminAgentSessionParticipant_UpdatedOn: '2025-01-01T00:00',
    to_AdminAgentSessionParticipant_UpdatedOn: '2025-12-31T23:59',
    orderBy: 'UpdatedOn',
    dir: 1 // Descending
   }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/sys/adminagentsessionparticipants',
    params={
        'from_AdminAgentSessionParticipant_UpdatedOn': '2025-01-01T00:00',
        'to_AdminAgentSessionParticipant_UpdatedOn': '2025-12-31T23:59',
        'orderBy': 'UpdatedOn',
        'dir': 1 // Descending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Response

200

AdminAgentSessionParticipant[]

The list of AdminAgentSessionParticipant records matching the query. See the Get one AdminAgentSessionParticipant endpoint for the full list of properties returned for each record.

integer

Current page number.

integer

Number of records per page.

string

The field used for sorting.

integer

The sort direction (0 = ascending, 1 = descending).

integer

Index of the first item on the current page.

integer

Index of the last item on the current page.

integer

Total number of matching records across all pages.

integer

Total number of pages.

boolean

Whether there is a next page of results.

boolean

Whether there is a previous page of results.

Example Response

{
  "Records": [
    {
      "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
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "CreatedOn",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}

Search AdminAgentSessionParticipants

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

import requests

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

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', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Search AdminAgentSessionParticipants

Authentication

Query Parameters

Filters

Range Filters

Code Examples

Simple listing

Filtering by CreatedOn

Range filters

Response

200