Get one AdminAgentSession

GET

api

sys

adminagentsessions

{id}

Get one AdminAgentSession

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

import requests

url = "https://spaces.nexudus.com/api/sys/adminagentsessions/{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/adminagentsessions/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "BusinessId": 123,
  "UserId": 123,
  "UserFullName": "<string>",
  "UserEmail": "<string>",
  "SessionId": "<string>",
  "Title": "<string>",
  "Channel": 123,
  "StartedOn": "<string>",
  "LastActivityOn": "<string>",
  "Status": 123,
  "Metadata": "<string>",
  "Mode": 123,
  "LastMessagePreview": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

An AdminAgentSession represents a conversation session between an admin user and the AI assistant within the Nexudus admin panel. Each session is linked to a specific Business and User (the operator), identified by a unique SessionId. Sessions track the conversation channel (Chat or API), status, and metadata such as page context.

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 AdminAgentSession-Read role.

Path Parameters

integer

required

The Id of the AdminAgentSession record to retrieve.

Code Examples

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

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

const record = await response.json();

import requests

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

record = response.json()

Response

200

integer

The business property.

integer

The user property.

string

Display value for User.FullName..

string

Display value for User.Email..

string

The sessionid property.

string

The title property.

integer

The channel property.

string

The startedon property.

string

The lastactivityon property.

integer

The status property.

string

The metadata property.

integer

Default routing of messages: Agent (assistant answers everything) or Chat (people talk, the assistant only answers when mentioned).

string

First characters of the most recent message (set automatically).

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

{
  "BusinessId": 0,
  "UserId": 0,
  "UserFullName": null,
  "UserEmail": null,
  "SessionId": null,
  "Title": null,
  "Channel": 0,
  "StartedOn": "2025-01-15T10:30:00Z",
  "LastActivityOn": "2025-01-15T10:30:00Z",
  "Status": 0,
  "Metadata": null,
  "Mode": 0,
  "LastMessagePreview": null,
  "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": "AdminAgentSession Example",
  "LocalizationDetails": null,
  "CustomFields": null
}

Get one AdminAgentSession

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

import requests

url = "https://spaces.nexudus.com/api/sys/adminagentsessions/{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/adminagentsessions/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "BusinessId": 123,
  "UserId": 123,
  "UserFullName": "<string>",
  "UserEmail": "<string>",
  "SessionId": "<string>",
  "Title": "<string>",
  "Channel": 123,
  "StartedOn": "<string>",
  "LastActivityOn": "<string>",
  "Status": 123,
  "Metadata": "<string>",
  "Mode": 123,
  "LastMessagePreview": "<string>",
  "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

Authentication

Path Parameters

Code Examples

Response

200