v1
latestOpenAPI 3.1.02026-07-2489171167.4 KBAgents
Get List of Agents
Retrieve a paginated list of agents in your account. Each agent record includes personal details, contact information, role-specific attributes, group membership, and company association.
get/agents
Query parameters
limitinteger
The number of records to return per page, up to 500.
offsetinteger
The offset for pagination. Calculated as (page - 1) * limit (page starts at 1).
querystring
Query to search by username, first name, last name, email or phone.
expandstring[]
Include additional related data in the response for the selected entity/entities.
Response
Returns a paginated list of agents.
Example response
{
"limit": 20,
"total": 50,
"data": [
{
"firstName": "John",
"lastName": "Doe",
"displayName": "John Doe",
"userEmail": "johndoe@sysaid.com",
"companyId": 342,
"departmentId": 342,
"locationId": 342,
"timezone": "Asia/Jerusalem",
"language": "en",
"managerId": 234,
"supervisorLevel": "department",
"jobTitle": "Engineering Director",
"permissionType": "user",
"userName": "johndoe",
"company": {
"name": "Alpha",
"address": "123 Main Street",
"address2": "Apt. 4B",
"city": "Washington",
"state": "Virginia",
"country": "USA",
"fax": "555-555-1234",
"notes": "Some notes about the company.",
"emailAccount": "company@mail.com",
"expirationDate": "30-12-2120",
"agreementId": 5,
"agreementStartDate": "22-10-2025",
"agreementEndDate": "01-08-2024",
"customFields": {
"company_cust_int_field": 5
},
"version": 5,
"id": 1
},
"groups": [
{
"name": "IT Support",
"supportLevel": 3,
"companyId": 1001,
"email": "support@example.com",
"receiveAutomaticSrEmailNotifications": true,
"canBeAssignedToServiceRecord": true,
"id": 123
}
],
"version": 13,
"id": 342
}
]
}