> ## 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.
</Note>

## Query Parameters

### Pagination & Sorting

<ParamField query="page" type="integer" default="1">
  The page number to retrieve.
</ParamField>

<ParamField query="size" type="integer" default="25">
  The number of records per page.
</ParamField>

<ParamField query="orderBy" type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField query="dir" type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField query="AdminAgentSessionParticipant_AdminAgentSession" type="integer">
  Filter by iD of the admin agent session.
</ParamField>

<ParamField query="AdminAgentSessionParticipant_AdminAgentSession_SessionId" type="string">
  Filter by display value for AdminAgentSession.SessionId..
</ParamField>

<ParamField query="AdminAgentSessionParticipant_AdminAgentSession_Title" type="string">
  Filter by display value for AdminAgentSession.Title..
</ParamField>

<ParamField query="AdminAgentSessionParticipant_User" type="integer">
  Filter by iD of the person taking part in the conversation.
</ParamField>

<ParamField query="AdminAgentSessionParticipant_User_FullName" type="string">
  Filter by display value for User.FullName..
</ParamField>

<ParamField query="AdminAgentSessionParticipant_User_Email" type="string">
  Filter by display value for User.Email..
</ParamField>

<ParamField query="AdminAgentSessionParticipant_InvitedBy" type="integer">
  Filter by user who invited this person (null for the owner).
</ParamField>

<ParamField query="AdminAgentSessionParticipant_InvitedBy_FullName" type="string">
  Filter by display value for InvitedBy.FullName..
</ParamField>

<ParamField query="AdminAgentSessionParticipant_Role" type="integer">
  Filter by owner (started the conversation) or Member (invited).
</ParamField>

<ParamField query="AdminAgentSessionParticipant_Status" type="integer">
  Filter by active, Left or Removed.
</ParamField>

<ParamField query="AdminAgentSessionParticipant_JoinedOn" type="string">
  Filter by uTC time the person joined the conversation.
</ParamField>

<ParamField query="AdminAgentSessionParticipant_LastReadOn" type="string">
  Filter by uTC time of the newest message this person has seen; messages after it count as unread.
</ParamField>

<ParamField query="AdminAgentSessionParticipant_LastDigestOn" type="string">
  Filter by uTC time of the newest message included in the last unread-messages email sent to this person.
</ParamField>

<ParamField query="AdminAgentSessionParticipant_DigestMuted" type="boolean">
  Filter by true when this person asked not to receive unread-message emails for this conversation.
</ParamField>

### Range Filters

<ParamField query="from_AdminAgentSessionParticipant_JoinedOn" type="string">
  Filter by uTC time the person joined the conversation greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_AdminAgentSessionParticipant_JoinedOn" type="string">
  Filter by uTC time the person joined the conversation less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="from_AdminAgentSessionParticipant_LastReadOn" type="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`.
</ParamField>

<ParamField query="to_AdminAgentSessionParticipant_LastReadOn" type="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`.
</ParamField>

<ParamField query="from_AdminAgentSessionParticipant_LastDigestOn" type="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`.
</ParamField>

<ParamField query="to_AdminAgentSessionParticipant_LastDigestOn" type="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`.
</ParamField>

<ParamField query="from_AdminAgentSessionParticipant_CreatedOn" type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_AdminAgentSessionParticipant_CreatedOn" type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="from_AdminAgentSessionParticipant_UpdatedOn" type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_AdminAgentSessionParticipant_UpdatedOn" type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```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()
  ```
</CodeGroup>

### Filtering by CreatedOn

<CodeGroup>
  ```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()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```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()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="AdminAgentSessionParticipant[]">
  The list of AdminAgentSessionParticipant records matching the query. See the [Get one AdminAgentSessionParticipant](/rest-api/sys/get-adminagentsessionparticipants-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```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
}
```