Get SmartBuddy by Name
Overview
Retrieve a SmartBuddy by its name.
Endpoint
GET /api/smartbuddy/byName
Use the service origin described in Getting started. The path above already includes /api.
Authentication
Send the access token obtained from Get Access Token in the Authorization header. Access is limited by the authenticated account’s permissions.
Request headers
Accept: application/json
Authorization: Bearer ACCESS_TOKEN
Query parameters
| Parameter | Type | Requirement | Description |
|---|---|---|---|
name | string | Required | SmartBuddy name. |
Request example
The following example uses cURL in a POSIX shell. Replace example credentials and IDs before running it. Replace the AI Command Center origin with your deployment address.
curl --request GET \
--url 'https://command-center.example.com/api/smartbuddy/byName?name=example-buddy' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer ACCESS_TOKEN'
Response
Successful status: 200 OK.
The following is an illustrative response with synthetic contact and credential values. Arrays are shortened to one representative item.
{
"userName": "DemoUser1",
"stationName": "example-station",
"jobCount": "",
"stationStatus": "Connected",
"permission": "Owner",
"buddyId": 3,
"tenantId": 1,
"userId": 2,
"stationId": 3,
"name": "ib-41_buddy",
"domainUser": "EXAMPLE\\sample-user",
"domainPwd": "REDACTED",
"description": "null",
"isEnabled": true,
"status": "Available",
"created": "2024-05-22T05:07:21.728771",
"modified": "2024-06-27T11:36:37.510337",
"createdBy": "Sample User",
"modifiedBy": "Sample User"
}
Response fields
The table describes selected fields in the response. Types reflect the example; this is not an exhaustive schema or nullability contract.
| Field | Example type | Description |
|---|---|---|
permission | string | Access level reported for the authenticated user. |
buddyId | integer | ID of the Buddy. |
tenantId | integer | ID of the tenant. |
userId | integer | ID of the user. |
isEnabled | boolean | Whether the resource is enabled. |
status | string | Resource or operation status shown in the example; the complete allowed set is not defined here. |
Errors
Endpoint-specific error statuses and response bodies are not yet documented. See Usage and troubleshooting for general handling guidance.