### Example GET Request with Pagination

Source: https://developers.sysaid.com/docs/api-standards-conventions

Demonstrates how to use the 'limit' and 'offset' parameters to paginate API results. Ensure to adjust these values based on your needs and API constraints.

```text
GET /api/v1/incidents?limit=50&offset=100
```

--------------------------------

### Not Found Error Response Example

Source: https://developers.sysaid.com/reference/addkbarticletoservicerecord

Example of a 404 Not Found error response.

```json
{
  "statusCode": 404,
  "message": "Requested resource was not found"
}
```

--------------------------------

### Example Response for Get Custom Fields

Source: https://developers.sysaid.com/docs/custom-fields

This JSON represents the response from the Get a List of Custom Fields endpoint, showing metadata for custom fields configured in SysAid.

```json
[
  {
    "fieldName": "sr_cust_soft_list",
    "fieldCaption": "Software Selection",
    "fieldType": "multiSelectList",
    "entityType": "sr",
    "values": {
      "1": "Adobe",
      "2": "Salesforce",
      "3": "MS Teams",
      "4": "Snag-It/Camtasia",
      "5": "Power BI",
      "6": "Teamviewer"
    }
  },
  {
    "fieldName": "sr_cust_equip_list",
    "fieldCaption": "Equipment list",
    "fieldType": "multiSelectList",
    "entityType": "sr",
    "values": {
      "1": "Desktop",
      "2": "Laptop",
      "3": "Monitor",
      "4": "Keyboard",
      "5": "Mouse",
      "6": "Headset"
    }
  }
]
```

--------------------------------

### Bad Request Error Response Example

Source: https://developers.sysaid.com/reference/addkbarticletoservicerecord

Example of a 400 Bad Request error response.

```json
{
  "statusCode": 400,
  "message": "Invalid request parameters"
}
```

--------------------------------

### Example JSON Response for Related Items

Source: https://developers.sysaid.com/reference/related-items

This is an example of a successful JSON response when retrieving related items. It includes lists of related service records, assets, CIs, and knowledge base articles, each with their respective details.

```json
{
  "success": true,
  "relatedItems": {
    "serviceRecords": [
      {
        "id": 456,
        "srType": "incident",
        "title": "Related Incident - Server Downtime",
        "relationship": 2
      }
    ],
    "assets": [
      {
        "serialNumber": "SN123456",
        "itemName": "Dell PowerEdge R740",
        "location": "Data Center A",
        "owner": "john.doe",
        "assetType": "Server",
        "relationship": 2
      }
    ],
    "cis": [
      {
        "id": 101,
        "ciName": "Production Web Server",
        "location": "AWS US-East-1",
        "owner": "operations",
        "ciType": "Virtual Machine",
        "relationship": 6
      }
    ],
    "kbArticles": [
      {
        "id": 234,
        "title": "How to Restart Application Server",
        "category": "Technical Documentation",
        "subCategory": "Server Management",
        "thirdLevelCategory": "Application Servers",
        "relationship": 6
      }
    ]
  }
}
```

--------------------------------

### Error Response Example

Source: https://developers.sysaid.com/reference/addkbarticletoservicerecord

Example of an error response from the API, including status code and a descriptive message.

```json
{
  "statusCode": 401,
  "message": "Invalid or missing authentication credentials"
}
```

--------------------------------

### GET /assets

Source: https://developers.sysaid.com/reference/getassets

Retrieve a paginated list of assets from the SysAid account.

```APIDOC
## GET /assets

### Description
Retrieve a paginated list of assets in your SysAid account.

### Method
GET

### Endpoint
/assets

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - The number of records that are returned per page (default 500).
- **offset** (integer) - Optional - The offset used for pagination.

### Response
#### Success Response (200)
- **assets** (array) - A list of asset objects.

#### Response Example
{
  "assets": [
    {
      "id": "MSI-123",
      "name": "KATANA-GF66",
      "type": "laptop",
      "manufacturer": "MSI"
    }
  ]
}
```

--------------------------------

### GET /license-manager/contracts

Source: https://developers.sysaid.com/reference/getlicensemanagercontracts

Retrieves a paginated list of software license contracts.

```APIDOC
## GET /license-manager/contracts

### Description
Retrieves a list of license contracts tracked in the License Manager with support for pagination and sorting.

### Method
GET

### Endpoint
/license-manager/contracts

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - The number of records to return per page, up to 500. Default: 20.
- **offset** (integer) - Optional - The offset for pagination. Default: 0.
- **query** (string) - Optional - Query to search entities.
- **sortBy** (string) - Optional - The field by which results are sorted. Default: "dateCreated".

### Response
#### Success Response (200)
- **data** (array) - A list of LicenseManagerContract objects.

#### Response Example
{
  "data": [
    {
      "id": "cm1a2b3c4d5e6f7g8h9i0j1k",
      "name": "Example Contract",
      "status": "active",
      "dateCreated": "2025-01-15T10:30:00.000Z",
      "dateUpdated": "2025-06-20T14:45:00.000Z"
    }
  ]
}
```

--------------------------------

### GET /license-manager/contracts

Source: https://developers.sysaid.com/changelog/new-contract-endpoints-in-license-manager

Retrieve a list of all software license contracts.

```APIDOC
## GET /license-manager/contracts

### Description
Retrieves a list of all contracts defined in the License Manager.

### Method
GET

### Endpoint
/license-manager/contracts
```

--------------------------------

### GET /websites/developers_sysaid

Source: https://developers.sysaid.com/reference/getlicensemanagerapplicationusers

Retrieves a list of applications within SysAid, with options for sorting.

```APIDOC
## GET /websites/developers_sysaid

### Description
Retrieves a list of applications within SysAid. Supports sorting by a specified direction.

### Method
GET

### Endpoint
/websites/developers_sysaid

### Query Parameters
- **sortDir** (string) - Optional - The direction in which results are sorted. Enum: ["asc", "desc"]. Defaults to "asc".

### Responses
#### Success Response (200)
- **applications** (array) - A list of application objects.

#### Error Responses
- **BadRequestError** (400) - The request was invalid or cannot be served.
- **UnauthorizedError** (401) - Authentication information is missing or invalid.
- **NotFoundError** (404) - The specified resource was not found.
- **InternalServerError** (500) - An unexpected error occurred on the server.
```

--------------------------------

### GET /assets

Source: https://developers.sysaid.com/reference/getassets

Retrieve a paginated list of assets in your SysAid account.

```APIDOC
## GET /assets

### Description
Retrieve a paginated list of assets in your SysAid account.

### Method
GET

### Endpoint
/assets
```

--------------------------------

### GET /companies

Source: https://developers.sysaid.com/reference/getcompanies

Retrieve a list of all companies configured in the SysAid account.

```APIDOC
## GET /companies

### Description
Retrieve a list of companies configured in your SysAid account.

### Method
GET

### Endpoint
/companies
```

--------------------------------

### GET /websites/developers_sysaid

Source: https://developers.sysaid.com/reference/agents-1

Retrieves a paginated list of agents with detailed information.

```APIDOC
## GET /websites/developers_sysaid

### Description
Returns a paginated list of agents.

### Method
GET

### Endpoint
/websites/developers_sysaid

### Query Parameters
- **limit** (integer) - Optional - The number of records that are returned per page.
- **offset** (integer) - Optional - The offset used for pagination.

### Response
#### Success Response (200)
- **limit** (integer) - The number of records that are returned per page.
- **offset** (integer) - The offset used for pagination.
- **total** (integer) - The total number of elements across all pages.
- **data** (array of objects) - The list of agents.
  - **firstName** (string) - The user's first name. Max length is 64 characters.
  - **lastName** (string) - The user's last name. Max length is 64 characters.
  - **displayName** (string) - The user's display name.
  - **userEmail** (string) - The user's email address.
  - **isDisabled** (boolean) - A disabled user is listed in the system, but does not have access to it. Default value is 'no' (user has access).
  - **companyId** (number | null) - Unique ID of the company the user works for.
  - **departmentId** (number | null) - Unique ID of the department the user belongs to.
  - **locationId** (number | null) - Unique ID of the location associated with the user.
  - **timezone** (string) - The user's timezone. By default, the timezone will be set to the one chosen for your SysAid account.
  - **language** (string) - The language used by the user. The default value is English.
  - **workPhone** (string) - User's work phone number/extension.
  - **mobile** (string) - User's mobile number.
  - **receiveSRNotifications** (boolean) - Enable or disable automatic service record email notifications when a service record is updated.
  - **enablePortalLogin** (boolean) - Enable the user to log into the Self-Service Portal.
  - **managerId** (integer) - Unique ID of the user's manager.
  - **supervisorLevel** (string) - enum - Give the user access to Self-Service Portal service records created by other users. Levels: `none`, `department`, `company`.
  - **jobTitle** (string | null) - The user's job title.
  - **permissionType** (string) - enum - Defines whether the Agent's permissions should be inherited from a group or set directly for this user. Values: `user`, `group`.
  - **userName** (string) - The name of the user as set by the SysAdmin.
  - **company** (object | null) - Company details.
  - **groups** (array of objects) - List of groups the user belongs to.
    - **name** (string) - required - The group's name. Max length is 64 characters.
    - **type** (string) - enum - required - The group type. Values: `general`, `administrators`, `end-users`.
    - **supportLevel** (integer) - Support level indicates in what order a service record moves through your support structure. Default value is 3.
    - **companyId** (integer | null) - Unique ID of the company the groups works for.
    - **email** (string) - The email address associated with the group. Max length is 256 characters.
    - **receiveAutomaticSrEmailNotifications** (boolean) - Indicates whether the group receives automatic service record email notifications when the record is updated.
    - **canBeAssignedToServiceRecord** (boolean) - Indicates if the group can be assigned to a service record. Not applicable if the group type is set to `end-users`.
    - **enableAutomaticDispatchOfServiceRecords** (boolean) - Determines if service records should be automatically dispatched. Only applicable if `canBeAssignedToServiceRecord` is true.
    - **id** (integer) - required - The unique identifier of the group.
    - **version** (int32) - The version parameter is used for optimistic locking.
  - **id** (int64) - The user's unique ID within SysAid.

#### Response Example
```json
{
  "limit": 10,
  "offset": 0,
  "total": 50,
  "data": [
    {
      "firstName": "John",
      "lastName": "Doe",
      "displayName": "John Doe",
      "userEmail": "john.doe@example.com",
      "isDisabled": false,
      "companyId": 1,
      "departmentId": 10,
      "locationId": 100,
      "timezone": "America/New_York",
      "language": "en",
      "workPhone": "123-456-7890",
      "mobile": "987-654-3210",
      "receiveSRNotifications": true,
      "enablePortalLogin": true,
      "managerId": 5,
      "supervisorLevel": "company",
      "jobTitle": "Software Engineer",
      "permissionType": "user",
      "userName": "johndoe",
      "company": {
        "id": 1,
        "name": "Example Corp"
      },
      "groups": [
        {
          "name": "Developers",
          "type": "general",
          "supportLevel": 2,
          "companyId": 1,
          "email": "developers@example.com",
          "receiveAutomaticSrEmailNotifications": true,
          "canBeAssignedToServiceRecord": true,
          "enableAutomaticDispatchOfServiceRecords": false,
          "id": 20,
          "version": 1
        }
      ],
      "id": 101
    }
  ]
}
```

#### Error Response (400)
- **message** (string) - Description of the error.

#### Error Response Example
```json
{
  "message": "Invalid request parameters."
}
```
```

--------------------------------

### GET /websites/developers_sysaid

Source: https://developers.sysaid.com/reference/getsrtemplatebysrid

Retrieves a template using the provided service record ID.

```APIDOC
## GET /websites/developers_sysaid

### Description
Allows to get a template by the service record ID.

### Method
GET

### Endpoint
/websites/developers_sysaid

### Parameters
#### Query Parameters
- **serviceRecordId** (string) - Required - The ID of the service record to retrieve the template for.
```

--------------------------------

### Get Companies

Source: https://developers.sysaid.com/reference/getcompanies

Retrieves a list of companies with pagination support. You can control the number of results per page and the starting offset.

```APIDOC
## GET /api/companies

### Description
Retrieves a paginated list of companies.

### Method
GET

### Endpoint
/api/companies

### Query Parameters
- **offset** (integer) - Optional - The offset for pagination. Calculated as `(page - 1) * limit` (page starts at 1). Default: 0
- **limit** (integer) - Optional - The number of items to display per page. The default is 100, and you can have up to 500. Default: 100

### Response
#### Success Response (200)
- **data** (array) - An array of Company objects.
- **total** (integer) - The total number of companies available.
- **offset** (integer) - The offset used for pagination.
- **limit** (integer) - The limit used for pagination.

#### Response Example
```json
{
  "data": [
    {
      "id": 1,
      "version": 5,
      "name": "Example Company",
      "customFields": {}
    }
  ],
  "total": 10,
  "offset": 0,
  "limit": 100
}
```

#### Error Response
- **statusCode** (integer) - HTTP status code.
- **message** (string) - A descriptive error message.

#### Error Response Example
```json
{
  "statusCode": 401,
  "message": "Invalid or missing authentication credentials"
}
```
```

--------------------------------

### Create SysAid Application Key Response

Source: https://developers.sysaid.com/docs/authentication-guide

This is a sample response after successfully creating an application key. You will receive your clientId and clientSecret, which are needed for generating access tokens.

```json
{
  "clientId": "your-client-id",
  "clientSecret": "your-client-secret",
  "applicationName": "your app name"
}
```

--------------------------------

### POST /assets

Source: https://developers.sysaid.com/reference/createasset

Create a new asset in your SysAid account.

```APIDOC
## POST /assets

### Description
Create a new asset in your SysAid account.

### Method
POST

### Endpoint
/assets

### Request Body
- **name** (string) - Optional - The name of the asset.
- **type** (string) - Optional - The asset type (Laptop / Smartphone / etc.).
- **source** (string) - Optional - The origin of the asset, describing how it was added to the system.
- **manufacturer** (string) - Optional - The manufacturer of the asset.
- **model** (string) - Optional - The model of the asset.
- **serial** (string) - Optional - The asset's serial number according to the manufacturer.
- **description** (string) - Optional - The description of the asset.
- **isDisabled** (boolean) - Optional - Indicates whether the asset is disabled.
- **ownerId** (number) - Optional - The unique ID of the user who owns the asset.

### Request Example
{
  "name": "KATANA-GF66",
  "type": "laptop",
  "manufacturer": "MSI",
  "model": "GF66 11UG-871",
  "serial": "SN1A2B3C4",
  "isDisabled": false
}

### Response
#### Success Response (201)
- **Asset created successfully.**

#### Response Example
{
  "id": 12345,
  "name": "KATANA-GF66"
}
```

--------------------------------

### Define ReadMe Explorer Settings

Source: https://developers.sysaid.com/reference/updateservicerecordactionitemstatus

Configuration for enabling explorer and proxy features in ReadMe.

```json
"x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
```

--------------------------------

### Create App Key cURL Request

Source: https://developers.sysaid.com/reference/authentication-1

Example request for generating application credentials using cURL.

```Shell
curl --request POST \
     --url https://your_account_id.sysaidit.com/connect/v1/application-keys \
     --header 'accept: application/json' \
     --header 'content-type: application/json'
```

--------------------------------

### GET /connect/v1/license-manager/applications

Source: https://developers.sysaid.com/reference/applications

Retrieve a paginated list of applications configured in your SysAid account with support for various filters.

```APIDOC
## GET /connect/v1/license-manager/applications

### Description
Retrieve a paginated list of applications configured in your SysAid account. You can use different criteria to filter the list.

### Method
GET

### Endpoint
https://{account}.sysaidit.com/connect/v1/license-manager/applications

### Parameters
#### Query Parameters
- **offset** (integer) - Optional - The offset for pagination. Defaults to 0.
- **limit** (integer) - Optional - The number of items to display per page (1-100). Defaults to 10.
- **sort** (array of strings) - Optional - Sort as field:direction pairs.
- **discoveryMethods** (array of objects) - Optional - Filter results by one or more discovery methods.
- **category** (array of objects) - Optional - Filter results by one or more categories.
- **state** (array of objects) - Optional - Filter results by one or more states.
- **dateCreatedFrom** (date) - Optional - Applications by date from which they were created.
- **dateCreatedTo** (date) - Optional - Applications by date to which they were created.
- **query** (string) - Optional - Query to search entities (length <= 255).
- **estimatedSavingsFrom** (number) - Optional - The minimum estimated savings to include in the results.
- **estimatedSavingsTo** (number) - Optional - The maximum estimated savings to include in the results.
- **utilizationRateFrom** (integer) - Optional - The minimum utilization rate (0-100).
- **utilizationRateTo** (integer) - Optional - The maximum utilization rate (0-100).
- **currency** (array of objects) - Optional - Filter results by one or more currencies.
- **utilizationRateMissing** (boolean) - Optional - Filter results by missing utilization rate.

### Response
#### Success Response (200)
- **limit** (integer) - The number of items returned per page.
- **offset** (integer) - The offset used for pagination.
- **total** (integer) - The total number of elements across all pages.
- **data** (array of objects) - List of application objects.
```

--------------------------------

### Get a Template with Service Record ID

Source: https://developers.sysaid.com/reference/templates

Allows to get a template by the service record ID.

```APIDOC
## GET /connect/v1/service-records/{recordId}/template

### Description
Allows to get a template by the service record ID.

### Method
GET

### Endpoint
https://{account}.sysaidit.com/connect/v1/service-records/{recordId}/template

### Parameters
#### Path Parameters
- **recordId** (integer) - required - The unique ID of the service record

### Responses
#### Success Response (200)
Service record template is found and returned.

#### Error Response (401)
Authentication information is missing or invalid

#### Error Response (404)
The specified resource was not found
```

--------------------------------

### POST /cis

Source: https://developers.sysaid.com/reference/createci

Creates a new configuration item (CI) within the SysAid system.

```APIDOC
## POST /cis

### Description
Creates a new CI in the SysAid system.

### Method
POST

### Endpoint
/cis

### Request Body
- **serialNumber** (string/null) - Optional - The serial number of the CI.
- **primaryCategoryId** (integer/null) - Optional - The primary category ID of the CI.
- **secondaryCategoryId** (integer/null) - Optional - The secondary category ID providing further classification.
- **thirdLevelCategoryId** (integer/null) - Optional - The tertiary classification ID of the item.
- **ownerId** (integer/null) - Optional - The unique identifier of the user who owns the CI.
- **ownerGroupId** (integer/null) - Optional - The unique identifier of the group that owns the CI.
- **locationId** (integer/null) - Optional - The identifier of the CI location.
- **companyId** (integer/null) - Optional - The identifier of the company the CI is assigned to.
- **statusId** (integer/null) - Optional - The identifier of the CI's status.
- **priorityId** (integer/null) - Optional - The identifier of the CI's priority level.
- **supplierId** (integer/null) - Optional - The identifier of the CI's supplier.

### Response
#### Success Response (201)
- **CI** (object) - The created CI object.
```

--------------------------------

### Successful Response for Get Indexes

Source: https://developers.sysaid.com/reference/indexes

This JSON object represents a successful response from the 'Get Indexes' API. It lists available indexes categorized by subject, such as 'priority' and 'status', with their respective IDs and captions.

```json
{
  "indexes": {
    "priority": [
      {
        "id": "1",
        "caption": "High"
      },
      {
        "id": "2",
        "caption": "Medium"
      },
      {
        "id": "3",
        "caption": "Low"
      }
    ],
    "status": [
      {
        "id": "1",
        "caption": "New"
      },
      {
        "id": "2",
        "caption": "Open"
      },
      {
        "id": "3",
        "caption": "Closed"
      }
    ]
  }
}
```

--------------------------------

### POST /connect/v1/application-keys

Source: https://developers.sysaid.com/reference/authentication-1

Creates a unique set of credentials (Client ID and Client Secret) for authenticating with the SysAid API.

```APIDOC
## POST /connect/v1/application-keys

### Description
Create a unique set of credentials (Client ID and Client Secret) for authenticating with the API. These credentials are required to request an access token.

### Method
POST

### Endpoint
https://{account}.sysaidit.com/connect/v1/application-keys

### Parameters
#### Headers
- **x-sysaid-accountid** (string) - Required - SysAid account identifier.

#### Request Body
- **userName** (string) - Required - The user name you use when signing into your SysAid account.
- **password** (string) - Required - The password you use when signing into your SysAid account.
- **applicationName** (string) - Required - This action creates an app entity for the user.
- **tokenLifetime** (integer) - Optional - The time in seconds until tokens generated with these credentials expire (Default: 86400, Max: 2592000).
- **description** (string) - Optional - Additional information about this app or user.

### Response
#### Success Response (201)
- **clientId** (string) - The client ID to use for authentication.
- **clientSecret** (string) - The client secret to use for authentication (only shown once).
- **applicationName** (string) - The name of the application.

#### Response Example
{
  "clientId": "string",
  "clientSecret": "string",
  "applicationName": "string"
}
```

--------------------------------

### Get Category Hierarchy cURL Request

Source: https://developers.sysaid.com/reference/categories-1

Use this cURL command to make a GET request to the API endpoint for retrieving category hierarchy. Ensure you replace 'your_account_id' with your actual account ID.

```shell
curl --request GET \
     --url https://your_account_id.sysaidit.com/connect/v1/categories \
     --header 'accept: application/json'
```

--------------------------------

### POST /license-manager/contracts

Source: https://developers.sysaid.com/changelog/new-contract-endpoints-in-license-manager

Create a new software license contract.

```APIDOC
## POST /license-manager/contracts

### Description
Creates a new contract record in the License Manager.

### Method
POST

### Endpoint
/license-manager/contracts
```

--------------------------------

### POST /contracts

Source: https://developers.sysaid.com/reference/createlicensemanagercontract

Creates a new license contract in the system.

```APIDOC
## POST /contracts

### Description
Creates a new license contract with the provided details.

### Method
POST

### Endpoint
/contracts

### Request Body
- **name** (string) - Required - The name of the contract.
- **applicationId** (string) - Required - The ID of the associated application.
- **status** (string) - Required - The current status of the contract.
- **startDate** (string) - Optional - The start date of the contract (format: date).
- **endDate** (string) - Optional - The end date of the contract (format: date).
- **paymentTerm** (string) - Optional - The billing frequency (annual, monthly, multiyear, quarterly, one-time, free).
- **contractValue** (number) - Optional - The total monetary value of the contract.
- **currency** (string) - Optional - ISO 4217 currency code.
- **licensesCount** (integer) - Optional - The number of licenses included.
- **autoRenewal** (boolean) - Optional - Indicates if the contract renews automatically (default: false).
- **cancellationNotice** (integer) - Optional - Days before end date for cancellation notice.
- **notes** (string) - Optional - Free-text notes about the contract.

### Request Example
{
  "name": "Enterprise License",
  "applicationId": "app-123",
  "status": "active",
  "startDate": "2025-01-01",
  "endDate": "2026-01-01",
  "paymentTerm": "annual",
  "contractValue": 12000,
  "licensesCount": 50,
  "autoRenewal": true,
  "cancellationNotice": 30,
  "notes": "Renewed with 10% discount"
}

### Response
#### Success Response (200)
- **id** (string) - The unique identifier of the newly created contract.

#### Response Example
{
  "id": "cm1a2b3c4d5e6f7g8h9i0j1k"
}
```

--------------------------------

### GET /connect/v1/license-manager/applications

Source: https://developers.sysaid.com/reference/applications

Retrieves a list of applications and their license details. Supports pagination and sorting.

```APIDOC
## GET /connect/v1/license-manager/applications

### Description
Retrieves a list of applications and their associated license information. This endpoint supports pagination and sorting to manage large datasets.

### Method
GET

### Endpoint
https://your_account_id.sysaid.com/connect/v1/license-manager/applications

### Query Parameters
- **offset** (integer) - Optional - The number of records to skip before starting to collect the result set.
- **limit** (integer) - Optional - The maximum number of records to return. Defaults to 20.
- **sort** (string) - Optional - Specifies the field and direction to sort the results. Format: `fieldName:direction` (e.g., `dateCreated:desc`).

### Request Example
```bash
curl --request GET \
     --url 'https://your_account_id.sysaid.com/connect/v1/license-manager/applications?offset=0&limit=10&sort=dateCreated%3Adesc' \
     --header 'accept: application/json'
```

### Response
#### Success Response (200)
- **limit** (integer) - The limit applied to the result set.
- **offset** (integer) - The offset applied to the result set.
- **total** (integer) - The total number of records available.
- **data** (array) - An array of application license objects.
  - **id** (string) - The unique identifier for the application.
  - **name** (string) - The name of the application.
  - **description** (string) - A description of the application.
  - **discoveryMethods** (array of strings) - Methods used to discover the application.
  - **category** (string) - The category the application belongs to.
  - **state** (string) - The current state of the application (e.g., active, inactive).
  - **vendor** (string) - The vendor of the application.
  - **website** (string) - The website URL for the application.
  - **icon** (string) - URL to the application's icon.
  - **totalLicenses** (integer) - The total number of licenses available for the application.
  - **activeUsers** (integer) - The number of currently active users.
  - **inactiveUsers** (integer) - The number of inactive users.
  - **utilizationRate** (number) - The license utilization rate.
  - **totalCost** (number) - The total cost associated with the licenses.
  - **costPerLicense** (number) - The cost per license.
  - **estimatedSavings** (number) - Estimated savings related to license management.
  - **compliance** (object) - Compliance status for various standards.
    - **SOC2** (boolean) - SOC2 compliance status.
    - **ISO_27001** (boolean) - ISO 27001 compliance status.
    - **GDPR** (boolean) - GDPR compliance status.
  - **currency** (string) - The currency used for cost information.
  - **dateCreated** (string) - The date and time when the application record was created (ISO 8601 format).
  - **dateUpdated** (string) - The date and time when the application record was last updated (ISO 8601 format).

#### Response Example
```json
{
  "limit": 20,
  "offset": 0,
  "total": 50,
  "data": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "discoveryMethods": [
        "string"
      ],
      "category": "string",
      "state": "string",
      "vendor": "string",
      "website": "string",
      "icon": "string",
      "totalLicenses": 0,
      "activeUsers": 0,
      "inactiveUsers": 0,
      "utilizationRate": 0,
      "totalCost": 0,
      "costPerLicense": 0,
      "estimatedSavings": 0,
      "compliance": {
        "SOC2": true,
        "ISO_27001": true,
        "GDPR": true
      },
      "currency": "string",
      "dateCreated": "2025-06-15T10:30:00Z",
      "dateUpdated": "2025-08-20T14:30:00Z"
    }
  ]
}
```

#### Error Response (500)
- **message** (string) - A message describing the unexpected server error.
```

--------------------------------

### cURL Request to Get Related Items

Source: https://developers.sysaid.com/reference/related-items

Use this cURL command to make a GET request to the API endpoint. Ensure you replace 'your_account_id' and 'recordId' with your actual values. The 'accept' header specifies the desired response format.

```shell
curl --request GET \
     --url https://your_account_id.sysaidit.com/connect/v1/service-records/recordId/related-items \
     --header 'accept: application/json'
```

--------------------------------

### Get Contracts

Source: https://developers.sysaid.com/reference/updatelicensemanagercontract

Retrieves a list of all license manager contracts.

```APIDOC
## GET /websites/developers_sysaid/contracts

### Description
Retrieves a list of all license manager contracts.

### Method
GET

### Endpoint
/websites/developers_sysaid/contracts

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - The maximum number of contracts to return.
- **offset** (integer) - Optional - The number of contracts to skip before returning results.

### Response
#### Success Response (200)
- **contracts** (array) - A list of contract objects.
  - **id** (string) - The unique identifier of the contract.
  - **name** (string) - The name of the contract.
  - **status** (string) - The current status of the contract.
  - **cancellationDeadline** (string) - The deadline for cancellation (ISO 8601 format).
  - **dateCreated** (string) - The timestamp of when the contract was created (ISO 8601 format).
  - **dateUpdated** (string) - The timestamp of when the contract was last updated (ISO 8601 format).

#### Response Example
{
  "contracts": [
    {
      "id": "60f3b2b3a1b2c3d4e5f6a7b8",
      "name": "Enterprise License",
      "status": "Active",
      "cancellationDeadline": "2025-12-02T23:59:59.000Z",
      "dateCreated": "2025-01-15T10:30:00.000Z",
      "dateUpdated": "2025-06-20T14:45:00.000Z"
    }
  ]
}
```

--------------------------------

### Get Contracts List

Source: https://developers.sysaid.com/reference/getlicensemanagercontracts

Retrieves a paginated list of contracts.

```APIDOC
## GET /api/contracts

### Description
Retrieve a paginated list of contracts in your SysAid account.

### Method
GET

### Endpoint
/api/contracts

### Query Parameters
- **page** (integer) - Optional - The page number to retrieve.
- **pageSize** (integer) - Optional - The number of items to return per page.

### Response
#### Success Response (200)
- **contracts** (array) - A list of contract objects.
  - **id** (integer) - The unique identifier for the contract.
  - **name** (string) - The name of the contract.
  - **startDate** (string) - The start date of the contract (ISO 8601 format).
  - **endDate** (string) - The end date of the contract (ISO 8601 format).
- **totalCount** (integer) - The total number of contracts available.
```

--------------------------------

### List All Applications

Source: https://developers.sysaid.com/reference/searchlicensemanagerapplications

Retrieves a paginated list of all applications managed by the License Manager.

```APIDOC
## GET /websites/developers_sysaid

### Description
Retrieves a paginated list of all applications within the License Manager system. This endpoint supports filtering and sorting.

### Method
GET

### Endpoint
/websites/developers_sysaid

### Parameters
#### Query Parameters
- **page** (integer) - Optional - The page number to retrieve.
- **pageSize** (integer) - Optional - The number of items per page.
- **sortBy** (string) - Optional - The field to sort the results by.
- **sortOrder** (string) - Optional - The order of sorting (asc or desc).
- **filter** (string) - Optional - Criteria to filter the applications.

### Response
#### Success Response (200)
- **data** (array) - An array of LicenseManagerApplication objects.
- **totalItems** (integer) - The total number of items available.
- **totalPages** (integer) - The total number of pages.
- **currentPage** (integer) - The current page number.

#### Response Example
{
  "data": [
    {
      "id": "app-123",
      "name": "Example App 1",
      "state": "approved",
      "category": "developer-tools",
      "discoveryMethod": "microsoft-entra-id",
      "totalLicenses": 100,
      "activeUsers": 75,
      "inactiveUsers": 25,
      "utilizationRate": 75,
      "totalCost": 5000.00,
      "costPerLicense": 50.00,
      "estimatedSavings": 1250.00,
      "compliance": {
        "SOC2": true,
        "ISO_27001": false,
        "GDPR": true
      },
      "currency": "USD",
      "dateCreated": "2025-06-15T10:30:00Z",
      "dateUpdated": "2025-08-20T14:30:00Z"
    },
    {
      "id": "app-456",
      "name": "Example App 2",
      "state": "under-review",
      "category": "operations",
      "discoveryMethod": "contract",
      "totalLicenses": 50,
      "activeUsers": 40,
      "inactiveUsers": 10,
      "utilizationRate": 80,
      "totalCost": 2500.00,
      "costPerLicense": 50.00,
      "estimatedSavings": 500.00,
      "compliance": {
        "SOC2": null,
        "ISO_27001": true,
        "GDPR": null
      },
      "currency": "USD",
      "dateCreated": "2024-11-01T09:00:00Z",
      "dateUpdated": "2025-01-10T11:00:00Z"
    }
  ],
  "totalItems": 2,
  "totalPages": 1,
  "currentPage": 1
}
```

--------------------------------

### GET /end-users

Source: https://developers.sysaid.com/reference/getendusers

Retrieves a paginated list of end users.

```APIDOC
## GET /end-users

### Description
Retrieves a paginated list of end users from the system.

### Method
GET

### Response
#### Success Response (200)
- **data** (array) - A list of EndUser objects.

#### Response Example
{
  "data": [
    {
      "id": 123,
      "jobTitle": "Engineering Director",
      "timezone": "Asia/Jerusalem"
    }
  ]
}
```

--------------------------------

### Get a List of Applications

Source: https://developers.sysaid.com/reference/searchlicensemanagerapplications

Retrieve a paginated list of applications configured in your SysAid account. You can use different criteria to filter the list.

```APIDOC
## GET /api/applications

### Description
Retrieve a paginated list of applications configured in your SysAid account. You can use different criteria to filter the list.

### Method
GET

### Endpoint
/api/applications

### Query Parameters
- **filter** (string) - Optional - Criteria to filter the list of applications.
- **page** (integer) - Optional - The page number for pagination.
- **pageSize** (integer) - Optional - The number of applications to return per page.

### Response
#### Success Response (200)
- **applications** (array) - A list of application objects.
  - **id** (integer) - The unique identifier for the application.
  - **name** (string) - The name of the application.
  - **description** (string) - A brief description of the application.
- **totalCount** (integer) - The total number of applications available.

#### Response Example
{
  "applications": [
    {
      "id": 1,
      "name": "Help Desk",
      "description": "Manage support tickets and customer requests."
    },
    {
      "id": 2,
      "name": "Asset Management",
      "description": "Track and manage IT assets."
    }
  ],
  "totalCount": 2
}
```

--------------------------------

### GET /license-manager/applications

Source: https://developers.sysaid.com/reference/searchlicensemanagerapplications

Retrieve a paginated list of applications configured in your SysAid account. You can use different criteria to filter the list.

```APIDOC
## GET /license-manager/applications

### Description
Retrieve a paginated list of applications configured in your SysAid account. You can use different criteria to filter the list.

### Method
GET

### Endpoint
/license-manager/applications

### Parameters
#### Query Parameters
- **offset** (integer) - Optional - The offset for pagination. Calculated as (page - 1) * limit (page starts at 1). Default: 0
- **limit** (integer) - Optional - The number of items to display per page. The default is 10, and you can have up to 100. Maximum: 100, Minimum: 1, Default: 10
- **sort** (array of strings) - Optional - Sort as field:direction pairs (e.g. ["name:asc", "dateCreated:desc"])
- **discoveryMethods** (string) - Optional - Filter results by discovery method.
- **category** (array of strings) - Optional - Filter results by one or more categories.
- **state** (array of strings) - Optional - Filter results by one or more states.
- **dateCreatedFrom** (string) - Optional - Applications by date from which they were created. Format: date
- **dateCreatedTo** (string) - Optional - Applications by date to which they were created. Format: date
- **query** (string) - Optional - Query to search entities. Maximum length: 255
- **estimatedSavingsFrom** (number) - Optional - The minimum estimated savings to include in the results (inclusive). Minimum: 0
- **estimatedSavingsTo** (number) - Optional - The maximum estimated savings to include in the results (inclusive). Minimum: 0
- **utilizationRateFrom** (integer) - Optional - The minimum utilization rate to include in the results (inclusive). Minimum: 0, Maximum: 100
- **utilizationRateTo** (integer) - Optional - The maximum utilization rate to include in the results (inclusive). Minimum: 0, Maximum: 100

### Response
#### Success Response (200)
- **applications** (array) - List of applications.
- **totalCount** (integer) - Total number of applications.

#### Response Example
{
  "applications": [
    {
      "id": "app-123",
      "name": "Example Application",
      "category": "Productivity",
      "state": "Active",
      "dateCreated": "2023-10-27T10:00:00Z",
      "estimatedSavings": 150.75,
      "utilizationRate": 75
    }
  ],
  "totalCount": 50
}
```

--------------------------------

### GET /ci/{id}

Source: https://developers.sysaid.com/reference/getcibyid

Retrieve a specific CI by its ID.

```APIDOC
## GET /ci/{id}

### Description
Retrieve a specific CI by its ID.

### Method
GET

### Endpoint
/ci/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the CI.
```

--------------------------------

### GET /api/categories/hierarchy

Source: https://developers.sysaid.com/reference/getcategories-1

Retrieves a hierarchical list of all available categories.

```APIDOC
## GET /api/categories/hierarchy

### Description
Returns a hierarchical list of categories.

### Method
GET

### Endpoint
/api/categories/hierarchy

### Response
#### Success Response (200)
- **categories** (array) - A list of category objects, each potentially containing nested subcategories.

#### Response Example
```json
{
  "categories": [
    {
      "id": "1",
      "name": "General",
      "subcategories": [
        {
          "id": "1.1",
          "name": "Inquiries"
        },
        {
          "id": "1.2",
          "name": "Complaints"
        }
      ]
    },
    {
      "id": "2",
      "name": "Technical Support",
      "subcategories": [
        {
          "id": "2.1",
          "name": "Hardware Issues"
        },
        {
          "id": "2.2",
          "name": "Software Issues"
        }
      ]
    }
  ]
}
```
```