---
updatedAt: 2026-07-21T12:13:15.000Z
agentTools:
  projectIndex: https://developers.sysaid.com/llms.txt
---

# Get Agent by ID

Retrieve detailed information about a specific Agent using their unique SysAid ID.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "SysAid Public API",
    "description": "API for managing SysAid resources",
    "version": "1.0.0",
    "contact": {
      "name": "SysAid Support",
      "email": "support@sysaid.com",
      "url": "https://www.sysaid.com"
    }
  },
  "tags": [
    {
      "name": "Agents",
      "description": "Operations for managing agents"
    }
  ],
  "servers": [
    {
      "url": "https://{account}.sysaidit.com/connect/v1",
      "description": "Production server",
      "variables": {
        "account": {
          "default": "your_account_id"
        }
      }
    }
  ],
  "paths": {
    "/agents/{id}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/AgentIdPathParam"
        },
        {
          "$ref": "#/components/parameters/UserExpandParam"
        }
      ],
      "get": {
        "summary": "Get Agent by ID",
        "description": "Retrieve detailed information about a specific Agent using their unique SysAid ID.",
        "operationId": "getAgent",
        "responses": {
          "200": {
            "description": "Successful operation",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Agent"
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/UnauthorizedError"
          },
          "404": {
            "$ref": "#/components/responses/NotFoundError"
          }
        },
        "tags": [
          "Agents"
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "PermissionType": {
        "type": "string",
        "enum": [
          "user",
          "group"
        ],
        "description": "Defines whether the Agent's permissions should be inherited from a group or set directly for this user.",
        "examples": [
          "user"
        ]
      },
      "UserName": {
        "type": "string",
        "description": "The name of the user as set by the SysAdmin.",
        "examples": [
          "johndoe"
        ]
      },
      "EntityVersion": {
        "type": "integer",
        "format": "int32",
        "description": "The version parameter is used for optimistic locking to prevent conflicts from concurrent updates. When updating a resource, you must include its current version value as received in the last GET request.  If the version you provide does not match the latest version on the server, the update will be rejected.  This ensures that you are not unintentionally overwriting changes made by another user or process, helping maintain data consistency and integrity.\n",
        "examples": [
          13
        ]
      },
      "Versioned": {
        "type": "object",
        "properties": {
          "version": {
            "$ref": "#/components/schemas/EntityVersion"
          }
        }
      },
      "UserId": {
        "type": "integer",
        "format": "int64",
        "description": "The user's unique ID within SysAid.",
        "examples": [
          342
        ]
      },
      "BaseUserProperties": {
        "type": "object",
        "properties": {
          "firstName": {
            "type": "string",
            "maxLength": 64,
            "description": "The user's first name. Max length is 64 characters.",
            "examples": [
              "John"
            ]
          },
          "lastName": {
            "type": "string",
            "maxLength": 64,
            "description": "The user's last name. Max length is 64 characters.",
            "examples": [
              "Doe"
            ]
          },
          "displayName": {
            "type": "string",
            "description": "The user's display name",
            "examples": [
              "John Doe"
            ]
          },
          "userEmail": {
            "type": "string",
            "description": "The user's email address.",
            "examples": [
              "johndoe@sysaid.com"
            ]
          },
          "isDisabled": {
            "type": "boolean",
            "description": "A diasbled user is listed in the system, but does not have access to it. Default value is 'no' (user has access).",
            "examples": [
              false
            ]
          },
          "companyId": {
            "oneOf": [
              {
                "type": "number"
              },
              {
                "type": "null"
              }
            ],
            "description": "Unique ID of the company the user works for",
            "examples": [
              342
            ]
          },
          "departmentId": {
            "oneOf": [
              {
                "type": "number"
              },
              {
                "type": "null"
              }
            ],
            "description": "Unique ID of the department the user belongs to.",
            "examples": [
              342
            ]
          },
          "locationId": {
            "oneOf": [
              {
                "type": "number"
              },
              {
                "type": "null"
              }
            ],
            "description": "Unique ID of the location associated with the user.",
            "examples": [
              342
            ]
          },
          "timezone": {
            "type": "string",
            "description": "The user's timezone. By default, the timezone will be set to the one chosen for your SysAid account.",
            "examples": [
              "Asia/Jerusalem"
            ]
          },
          "language": {
            "type": "string",
            "description": "The language used by the user. The default value is  English.",
            "examples": [
              "en"
            ]
          },
          "workPhone": {
            "type": "string",
            "description": "User's work phone number/extension",
            "examples": [
              18005551234
            ]
          },
          "mobile": {
            "type": "string",
            "description": "User's mobile number.",
            "examples": [
              18005551234
            ]
          },
          "receiveSRNotifications": {
            "type": "boolean",
            "description": "Enable or disable automatic service record email notifications when a service record is updated."
          },
          "enablePortalLogin": {
            "type": "boolean",
            "description": "Enable the user to log into the Self-Service Portal."
          },
          "managerId": {
            "type": "integer",
            "description": "Unique ID of the user's manager.",
            "examples": [
              234
            ]
          },
          "supervisorLevel": {
            "type": "string",
            "enum": [
              "none",
              "department",
              "company"
            ],
            "description": "Give the user access to Self-Service Portal service records created by other users. \nThere are 3 levels: \n- Regular user: Cannot view service records that do not belong to them (default). \n- Department: Can view service records created by anyone in their department. \n- Company: Can view service records created by anyone in the company.\n",
            "examples": [
              "department"
            ]
          },
          "jobTitle": {
            "type": "string",
            "nullable": true,
            "description": "The user's job title.",
            "examples": [
              "Engineering Director"
            ]
          }
        }
      },
      "EditableAgentProperties": {
        "allOf": [
          {
            "$ref": "#/components/schemas/BaseUserProperties"
          },
          {
            "type": "object",
            "properties": {
              "permissionType": {
                "$ref": "#/components/schemas/PermissionType"
              }
            }
          }
        ]
      },
      "NonEditableUserProperties": {
        "type": "object",
        "properties": {
          "userName": {
            "$ref": "#/components/schemas/UserName"
          },
          "company": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/Company"
              },
              {
                "type": "null"
              }
            ]
          },
          "groups": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Group"
            }
          }
        }
      },
      "AgentProperties": {
        "allOf": [
          {
            "$ref": "#/components/schemas/EditableAgentProperties"
          },
          {
            "$ref": "#/components/schemas/NonEditableUserProperties"
          }
        ]
      },
      "VersionedAgentProperties": {
        "allOf": [
          {
            "$ref": "#/components/schemas/AgentProperties"
          },
          {
            "$ref": "#/components/schemas/Versioned"
          }
        ]
      },
      "Agent": {
        "allOf": [
          {
            "$ref": "#/components/schemas/VersionedAgentProperties"
          },
          {
            "type": "object",
            "properties": {
              "id": {
                "$ref": "#/components/schemas/UserId"
              }
            }
          }
        ]
      },
      "ErrorResponse": {
        "type": "object",
        "properties": {
          "statusCode": {
            "type": "integer",
            "description": "HTTP status code.",
            "example": 401
          },
          "message": {
            "type": "string",
            "description": "A descriptive error message.",
            "example": "Invalid or missing authentication credentials"
          }
        }
      },
      "GroupProperties": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 64,
            "description": "The group's name.",
            "examples": [
              "IT Support"
            ]
          },
          "type": {
            "type": "string",
            "enum": [
              "general",
              "administrators",
              "end-users"
            ],
            "description": "The group type. The group permissions will be set according to the indicated type."
          },
          "supportLevel": {
            "type": "integer",
            "description": "Support level indicates in what order a service record moves through your support structure. \nFor example, all service records might go to 1st level. Difficult service records that 1st level can't solve would be passed on to 2nd level, and only special cases might be advanced from 2nd level to 3rd level.\nThe support level of an Agent in more than one group is the highest support level of any of the groups he is in. Only relevant for Admin type groups.\nThe support level determines the permissions and access rights associated with the group.\nThe default value is 3.\n",
            "examples": [
              3
            ]
          },
          "companyId": {
            "type": "integer",
            "nullable": true,
            "description": "Unique ID of the company the groups works for.",
            "examples": [
              1001
            ]
          },
          "email": {
            "type": "string",
            "format": "email",
            "maxLength": 256,
            "description": "The email address associated with the group.",
            "examples": [
              "support@example.com"
            ]
          },
          "receiveAutomaticSrEmailNotifications": {
            "type": "boolean",
            "description": "Indicates whether the group receives automatic service record email notifications when the record is updated.",
            "examples": [
              true
            ]
          },
          "canBeAssignedToServiceRecord": {
            "type": "boolean",
            "description": "Indicates if the group can be assigned to a service record. Not applicable if the group type is set to `end-users`.",
            "examples": [
              true
            ]
          },
          "enableAutomaticDispatchOfServiceRecords": {
            "type": "boolean",
            "description": "Determines if service records should be automatically dispatched. Only applicable if the `canBeAssignedToServiceRecord` is set to `true`.",
            "examples": [
              false
            ]
          }
        },
        "required": [
          "name",
          "type"
        ]
      },
      "Group": {
        "allOf": [
          {
            "$ref": "#/components/schemas/GroupProperties"
          },
          {
            "type": "object",
            "properties": {
              "id": {
                "type": "integer",
                "description": "The unique identifier of the group.",
                "examples": [
                  123
                ]
              }
            },
            "required": [
              "id"
            ]
          }
        ]
      },
      "Company": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "The company's unique SysAid ID.",
            "examples": [
              1
            ]
          },
          "name": {
            "type": "string",
            "description": "The company's name.",
            "examples": [
              "Alpha"
            ]
          }
        }
      }
    },
    "parameters": {
      "UserExpandParam": {
        "name": "expand",
        "in": "query",
        "required": false,
        "description": "Include additional related data in the response for the selected entity/entities.",
        "schema": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string",
            "enum": [
              "groups",
              "company"
            ]
          }
        }
      },
      "AgentIdPathParam": {
        "name": "id",
        "in": "path",
        "required": true,
        "description": "The agent's unique SysAid ID.",
        "schema": {
          "$ref": "#/components/schemas/UserId"
        }
      }
    },
    "responses": {
      "UnauthorizedError": {
        "description": "Authentication information is missing or invalid",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            },
            "example": {
              "statusCode": 401,
              "message": "Invalid or missing authentication credentials"
            }
          }
        }
      },
      "NotFoundError": {
        "description": "The specified resource was not found",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            },
            "example": {
              "statusCode": 404,
              "message": "Requested resource was not found"
            }
          }
        }
      }
    },
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      }
    }
  },
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```