> ## Documentation Index
> Fetch the complete documentation index at: https://learn.nexudus.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Search AdminAgentSessionParticipants

> Search and list AdminAgentSessionParticipant records with filtering, sorting, and pagination.

A person taking part in an admin agent conversation

## Authentication

> [!NOTE]
>
> 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

**page** `integer` (default: 1)

The page number to retrieve.

**size** `integer` (default: 25)

The number of records per page.

**orderBy** `string`

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

**dir** `integer`

Sort direction. `0` for ascending, `1` for descending.

### Filters

**AdminAgentSessionParticipant\_AdminAgentSession** `integer`

Filter by iD of the admin agent session.

**AdminAgentSessionParticipant\_AdminAgentSession\_SessionId** `string`

Filter by display value for AdminAgentSession.SessionId..

**AdminAgentSessionParticipant\_AdminAgentSession\_Title** `string`

Filter by display value for AdminAgentSession.Title..

**AdminAgentSessionParticipant\_User** `integer`

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

**AdminAgentSessionParticipant\_User\_FullName** `string`

Filter by display value for User.FullName..

**AdminAgentSessionParticipant\_User\_Email** `string`

Filter by display value for User.Email..

**AdminAgentSessionParticipant\_InvitedBy** `integer`

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

**AdminAgentSessionParticipant\_InvitedBy\_FullName** `string`

Filter by display value for InvitedBy.FullName..

**AdminAgentSessionParticipant\_Role** `integer`

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

**AdminAgentSessionParticipant\_Status** `integer`

Filter by active, Left or Removed.

**AdminAgentSessionParticipant\_JoinedOn** `string`

Filter by uTC time the person joined the conversation.

**AdminAgentSessionParticipant\_LastReadOn** `string`

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

**AdminAgentSessionParticipant\_LastDigestOn** `string`

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

**AdminAgentSessionParticipant\_DigestMuted** `boolean`

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

### Range Filters

**from\_AdminAgentSessionParticipant\_JoinedOn** `string`

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

**to\_AdminAgentSessionParticipant\_JoinedOn** `string`

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

**from\_AdminAgentSessionParticipant\_LastReadOn** `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`.

**to\_AdminAgentSessionParticipant\_LastReadOn** `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`.

**from\_AdminAgentSessionParticipant\_LastDigestOn** `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`.

**to\_AdminAgentSessionParticipant\_LastDigestOn** `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`.

**from\_AdminAgentSessionParticipant\_CreatedOn** `string`

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

**to\_AdminAgentSessionParticipant\_CreatedOn** `string`

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

**from\_AdminAgentSessionParticipant\_UpdatedOn** `string`

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

**to\_AdminAgentSessionParticipant\_UpdatedOn** `string`

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

## Code Examples

### Simple listing

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

```javascript JavaScript theme={null}
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();
```

```python Python theme={null}
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

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

```javascript JavaScript theme={null}
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();
```

```python Python theme={null}
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

```bash cURL theme={null}
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"
```

```javascript JavaScript theme={null}
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();
```

```python Python theme={null}
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

**Records** `AdminAgentSessionParticipant[]`

The list of AdminAgentSessionParticipant records matching the query. See the [Get one AdminAgentSessionParticipant](https://learn.nexudus.com/rest-api/sys/get-adminagentsessionparticipants-by-id.md) endpoint for the full list of properties returned for each record.

**CurrentPage** `integer`

Current page number.

**CurrentPageSize** `integer`

Number of records per page.

**CurrentOrderField** `string`

The field used for sorting.

**CurrentSortDirection** `integer`

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

**FirstItem** `integer`

Index of the first item on the current page.

**LastItem** `integer`

Index of the last item on the current page.

**TotalItems** `integer`

Total number of matching records across all pages.

**TotalPages** `integer`

Total number of pages.

**HasNextPage** `boolean`

Whether there is a next page of results.

**HasPreviousPage** `boolean`

Whether there is a previous page of results.

```json Example Response theme={null}
{
  "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": "admin@example.com",
      "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
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.