# SysAid Developers Documentation > SysAid Developers API docs: secure RESTful ITSM endpoints for service records, users, assets and more. Interactive guides, token auth, live examples. ## Guides: Guides - [Getting Started](https://developers.sysaid.com/docs/sysaid-api-overview.md) - [Authentication Guide](https://developers.sysaid.com/docs/authentication-guide.md) - [API Standards & Conventions](https://developers.sysaid.com/docs/api-standards-conventions.md) - [Webhooks Overview](https://developers.sysaid.com/docs/webhooks-overview.md) - [Custom Fields Guide](https://developers.sysaid.com/docs/custom-fields.md) ## API Reference: SysAid Public API - Authentication - [Create App Key](https://developers.sysaid.com/reference/createapplicationkey.md): 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 and should be securely stored. Each user… - [Generate Access Token](https://developers.sysaid.com/reference/generateaccesstoken-1.md): Obtain a temporary access token for authenticating API requests. To generate the token, provide your Client ID and Client Secret obtained from the Generate App Key endpoint. - [Delete App Key](https://developers.sysaid.com/reference/deleteapplicationkey.md): Deletes an application key identified by its client ID. Once deleted, the key can no longer be used for authentication. - [Get App Keys by Account ID](https://developers.sysaid.com/reference/getapplicationsbyaccountid.md): Retrieve all the applications associated with the authenticated account, including a list of applications with their metadata including client ID, name, and associated username. - [Users](https://developers.sysaid.com/reference/users.md) - Agents - [Get List of Agents](https://developers.sysaid.com/reference/getagents.md): 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. - [Create a New Agent](https://developers.sysaid.com/reference/createagent.md): Create a new IT Agent user in your SysAid account. This person will be able to access and manage service records. For aditional permissions, see the [Edit… - [Get Agent by ID](https://developers.sysaid.com/reference/getagent.md): Retrieve detailed information about a specific Agent using their unique SysAid ID. - [Update Agent Details](https://developers.sysaid.com/reference/updateagent.md): Update the details of an existing Agent identified by their SysAid ID. The new values provided will overwrite existing values. - [Delete Agent](https://developers.sysaid.com/reference/deleteagent.md): Permanently delete an Agent from your SysAid account using their unique ID. This action is irreversible. Once deleted, the Agent's data cannot be recovered. Use this endpoint with caution to remove… - [Add Agent to Groups](https://developers.sysaid.com/reference/addagenttogroups.md): Add a specific Agent to one or more existing user groups in your SysAid account. - [Remove Agent from Groups](https://developers.sysaid.com/reference/removeagentfromgroups.md): Remove a specific Agent from one or more user groups. Removing an agent from all groups may affect their access permissions and assignment behavior. - [Convert Agent to End user](https://developers.sysaid.com/reference/convertagenttoenduser-1.md): Convert an existing Agent into an End user. This action removes the Agent's elevated permissions and system roles, effectively transitioning them to a standard user profile. Admin group memberships,… - End Users - [Get List of End Users](https://developers.sysaid.com/reference/getendusers.md): Retrieve a paginated list of end users in your SysAid account. - [Create a New End User](https://developers.sysaid.com/reference/createenduser.md): Creates a new end user in your SysAid account. - [Get End User by ID](https://developers.sysaid.com/reference/getenduser.md): Retrieve detailed information about a specific end user using their unique SysAid ID. - [Update End User Details](https://developers.sysaid.com/reference/updateenduser.md): Update the details of an existing end user identified by their SysAid ID. The new values provided will overwrite existing values. - [Delete End User](https://developers.sysaid.com/reference/deleteenduser.md): Permanently delete an end user from your SysAid account using their unique ID. This action is irreversible. Once deleted, the end users' data cannot be recovered. Use this endpoint with caution to… - [Add End User to Groups](https://developers.sysaid.com/reference/addendusertogroups.md): Add a specific end user to one or more existing user groups in your SysAid account. - [Remove End User from Groups](https://developers.sysaid.com/reference/removeenduserfromgroups.md): Remove a specific End User from one or more user groups. - [Convert End User to Agent](https://developers.sysaid.com/reference/convertendusertoagent-1.md): Convert an existing end user into an Agent. This action grants the user agent-level permissions and enables them to be assigned to service records, join support groups, and access agent-only… - Groups - [Get List of Groups](https://developers.sysaid.com/reference/getgroups-1.md): Retrieve a list of all user groups in your SysAid account. - [Create a New Group](https://developers.sysaid.com/reference/creategroup.md): Creates a new user group in your SysAid account. - [Get Group by ID](https://developers.sysaid.com/reference/getgroup.md): Retrieve detailed information about a specific group using its unique ID. - [Get Group Members](https://developers.sysaid.com/reference/getgroupmembers.md): Retrieve a list of all users assigned to a specific group by its unique ID. - [Get list of groups](https://developers.sysaid.com/reference/getgroups-2.md): Retrieves a paginated list of groups. - [Create a new group](https://developers.sysaid.com/reference/creategroup-2.md): Creates a new group. Provide the necessary details as per the group type. - [Get group by ID](https://developers.sysaid.com/reference/getgroup-2.md): Retrieves the details of a specific group by its unique identifier. - [Get group members](https://developers.sysaid.com/reference/getgroupmembers-2.md): Retrieves a paginated list of user IDs assigned to the specified group. - Service Records - General - [Create a Service Record](https://developers.sysaid.com/reference/createservicerecord.md): Create a new service record (ticket) in your SysAid account. - [Update Service Record Details](https://developers.sysaid.com/reference/updateservicerecord.md): Update the details of an existing service record using its unique SysAid ID. - [Get a Service Record by ID](https://developers.sysaid.com/reference/getservicerecordbyid.md): Retrieve the full details of a specific service record using its unique SysAid ID. - [Search Service Records by Specific Parameters](https://developers.sysaid.com/reference/searchservicerecords.md): Search for service records based on filters, fields or customized query parameters. You can filter records using fields such as status, category, priority, assigned group or agent, creation date,… - [Delete a Service Record](https://developers.sysaid.com/reference/deleteservicerecord.md): Permanently deletes a service record using its unique ID. This action is irreversible and will remove the record and all associated data from your SysAid account. Deleting a service record may… - [Resolve a Service Record](https://developers.sysaid.com/reference/resolveservicerecord.md): Mark a service record as resolved. Use this endpoint to update the status of an open ticket to indicate that the issue has been addressed. - [Add Activity to a Service Record](https://developers.sysaid.com/reference/addservicerecordactivity.md): Add a time-tracked activity entry to an existing service record. Activities typically represent work performed, such as troubleshooting, communication, or on-site visits. To learn more about… - [Get a List of Service Record Activities](https://developers.sysaid.com/reference/searchservicerecordactivities.md): Retrieve a paginated list of service record activities in your SysAid account. You can use different criteria to filter the list. You must apply at least one filter parameter to run the endpoint. - [Send a Message from a Service Record](https://developers.sysaid.com/reference/sendservicerecordmessage-1.md): Send an email notification directly from a specific service record to an end user or agent. - [Add a Note to a Service Record](https://developers.sysaid.com/reference/addservicerecordnote.md): Add an internal or public note to an existing service record. - [Get a List of Service Record Notes](https://developers.sysaid.com/reference/getservicerecordnotes.md): Retrieve a paginated list of notes for a single service record in your SysAid account. You must have view permission for the service record — the same access required to view it in SysAid. - [Search Service Record Notes](https://developers.sysaid.com/reference/searchservicerecordnotes.md): Search for notes across specific service records in your SysAid account and retrieve the results as a paginated list. The srIds filter is required, and you can use additional filters to narrow the… - Action Items - [Get Service Record's Action Items](https://developers.sysaid.com/reference/getservicerecordactionitems.md): Allows to retrieve service record's action items. - [Update an Action Item Status](https://developers.sysaid.com/reference/updateservicerecordactionitemstatus.md): Allows to update the service record's action item status - [Add an Ad Hoc Action Item to a Service Record](https://developers.sysaid.com/reference/addadhocactionitem.md): Create a new ad-hoc action item and add it to the workflow of a specific service record. - [Delete an Ad Hoc Action Item from a Service Record](https://developers.sysaid.com/reference/deleteadhocactionitem.md): Remove an action item from the workflow of a specific service record. - Related Items - [Get a List of Related Items for a Service Record](https://developers.sysaid.com/reference/getservicerecordrelateditems.md): Retrieve all related items (service records, assets, CIs, and knowledge base articles) associated with a specific service record ID. - [Link Knowledge Base Articles to a Service Record](https://developers.sysaid.com/reference/addkbarticletoservicerecord.md): Link one or more knowledge base articles to a specific service record. Articles will always be linked with the "relates to" relationship type. - [Unlink a Knowledge Base Article from a Service Record](https://developers.sysaid.com/reference/deleteservicerecordknowledgebaserelateditem.md): Delete the relationship between a knowledge base article and a service record. This will not delete the knowledge article itself, only the connection between the two entities. - Templates - [Get a Template with Service Record ID](https://developers.sysaid.com/reference/getsrtemplatebysrid.md): Allows to get a template by the service record ID. - [Get a Service Record Template by ID](https://developers.sysaid.com/reference/getsrtemplatebyid.md): Allows to get a service record template by ID. - [Search Service Record Templates](https://developers.sysaid.com/reference/searchsrtemplates.md): Allows to search service record templates by different criteria. - Attachments - [Generates a Presigned URL for an Attachment Upload](https://developers.sysaid.com/reference/generateattachmentpresignedurl.md): The 1st step in the new attachment creation flow - a request to generate a presigned URL that the client can use to upload an attachment - [Create a New Attachment](https://developers.sysaid.com/reference/createattachment.md): Finalize new attachment creation after the initial call to generate_presigned_url. The is the 3rd call made by the client in the creation flow (1st is generating a presigned URL, 2nd - uploading the… - [The 1st step in the new attachment creation flow - a request to generate a presigned URL that the client can use to upload an attachment ](https://developers.sysaid.com/reference/generateattachmentpresignedurl-1.md): Generates a presigned url for an attachment upload - [Finalize new attachment creation after the initial call to generate_presigned_url. The is the 3rd call made by the client in the creation flow (1st is generating a presigned URL, 2nd - uploading the object to storage using the presigned URL). ](https://developers.sysaid.com/reference/createattachment-1.md): Create new attachment - Groups - [Get a List of Groups](https://developers.sysaid.com/reference/getgroups.md): Retrieves a paginated list of groups. - [Create a New Group](https://developers.sysaid.com/reference/creategroup-1.md): Creates a new group. Provide the necessary details as per the group type. - [Get Group by ID](https://developers.sysaid.com/reference/getgroup-1.md): Retrieves the details of a specific group by its unique identifier. - [Get Group Members](https://developers.sysaid.com/reference/getgroupmembers-1.md): Retrieve a paginated list of user IDs assigned to the specified group. - Companies - [Get List of Companies](https://developers.sysaid.com/reference/getcompanies.md): Retrieve a list of companies configured in your SysAid account. - [Create a New Company](https://developers.sysaid.com/reference/createcompany.md): Create a new company in your SysAid account. - [Get Company by ID](https://developers.sysaid.com/reference/getcompanybyid.md): Retrieve a company by its ID. - [Update a Company](https://developers.sysaid.com/reference/updatecompanybyid.md): Update the details of an existing company in your SysAid account. - [Delete Company by ID](https://developers.sysaid.com/reference/deletecompanybyid.md): Delete a company by its ID. - [Configuration Items (CIs)](https://developers.sysaid.com/reference/cis-1.md) - [Get a List of CIs](https://developers.sysaid.com/reference/getcis.md): Retrieve a list of configuration items (CIs) from your SysAid CMDB. - [Create a New CI](https://developers.sysaid.com/reference/createci.md): Create a new CI in your SysAid account. - [Get a CI by ID](https://developers.sysaid.com/reference/getcibyid.md): Retrieve a specific CI by its ID. - [Update the CI by ID](https://developers.sysaid.com/reference/updatecibyid.md): Update a specific CI by its ID. - [Delete a CI by ID](https://developers.sysaid.com/reference/deletecibyid.md): Delete a CI using its ID. All links that use this CI will be removed. Once deleted, the data cannot be recovered. - [Get a List of CI Types](https://developers.sysaid.com/reference/getcitypes.md): Retrieve a list of the CI types that exist in your SysAid account. - [Get CI Relations for a Specific CI by ID](https://developers.sysaid.com/reference/getcirelationsbyid.md): Retrieve all CI relations for a specific CI using its unique ID. - [Create a CI Relation for a Specific CI ID](https://developers.sysaid.com/reference/createcirelation.md): Create a CI relation for a specific CI using its unique ID. - [Delete a CI Relation for a Specific CI ID](https://developers.sysaid.com/reference/deletecirelation.md): Permanently delete a CI relation for a specific CI using its unique ID. - [Get CI Relation Types](https://developers.sysaid.com/reference/getcirelationtypes.md): Retrieve a list of CI relation types configured in SysAid. - [Create a CI Relation Type](https://developers.sysaid.com/reference/createcirelationtype.md): Create a new CI relation type. This relation type will be available for all CIs. - [Update a CI Relation Type by ID](https://developers.sysaid.com/reference/updatecirelationtype.md): Update a CI relation type by its unique ID. This only applies to custom CI relation types as Standard CI relation types cannot be updated. - [Delete a CI Relation Type by ID](https://developers.sysaid.com/reference/deletecirelationtype.md): Delete a CI relation type by its unique ID. All CI links using this relation type will be removed. Once deleted, the data cannot be recovered. - [Get a List of CI Subtypes for a Specific CI Type](https://developers.sysaid.com/reference/getcisubtypesbycitypeid.md): Retrieve a list of all CI subtypes available for a specific CI type. - Categories - [Get Category Hierarchy](https://developers.sysaid.com/reference/getcategories-1.md): Returns a hierarchical list of categories. - [Assets](https://developers.sysaid.com/reference/assets-1.md) - [Get list of assets](https://developers.sysaid.com/reference/getassets.md): Retrieves a list of assets. - [Create a New Asset](https://developers.sysaid.com/reference/createasset.md): Create a new asset in your SysAid account. - [Get an Asset by ID](https://developers.sysaid.com/reference/getassetbyid.md) - [Update an Asset](https://developers.sysaid.com/reference/updateasset.md): Update the details of an existing asset. Existing fields will be overwritten with newly provided information. - [Delete an Asset](https://developers.sysaid.com/reference/deleteasset.md): Delete an asset from your SysAid account. This action is irreversible. - License Manager - Contrats - [Get a List of Contracts](https://developers.sysaid.com/reference/getlicensemanagercontracts.md): Retrieve a paginated list of contracts in your SysAid account. - [Create a Contract](https://developers.sysaid.com/reference/createlicensemanagercontract.md): Create a new contract in your SysAid account. - [Create Multiple Contracts](https://developers.sysaid.com/reference/createmultiplelicensemanagercontracts.md): Create multiple contracts in a single request, supporting up to 1,000 contracts at a time. The response returns the new contract IDs in the same order you sent them. To ensure consistency, contracts… - [Get a Contract by ID](https://developers.sysaid.com/reference/getlicensemanagercontractbyid.md): Retrieve information about an existing contract. - [Update a Contract](https://developers.sysaid.com/reference/updatelicensemanagercontract.md): Update the details of an existing contract. Only the fields included in the request body will be updated. - [Delete a Contract](https://developers.sysaid.com/reference/deletelicensemanagercontract.md): Permanently delete a contract from your SysAid account. This action is irreversible. - Applications - [Get a List of Applications](https://developers.sysaid.com/reference/searchlicensemanagerapplications.md): Retrieve a paginated list of applications configured in your SysAid account. You can use different criteria to filter the list. - [Create Application](https://developers.sysaid.com/reference/createlicensemanagerapplication.md): Create a new application manually. Intended for applications that are not automatically discovered. - [Get an Application by ID](https://developers.sysaid.com/reference/getlicensemanagerapplicationbyid.md): Retrieve a specific application by its unique identifier. - [Update Application Details](https://developers.sysaid.com/reference/updatelicensemanagerapplication.md): Update the details of an existing application. Only the fields included in the request body will be updated. - [Delete an Application](https://developers.sysaid.com/reference/deletelicensemanagerapplication.md): Delete an application. This operation performs a soft delete, meaning the application is marked as deleted but the data is retained for audit purposes. - [Get a List of Application Users](https://developers.sysaid.com/reference/getlicensemanagerapplicationusers.md): Retrieve a paginated list of users tracked for a specific application based on audit log activity from the last 30 days. - Users - [Get a List of Application Users Across All Applications](https://developers.sysaid.com/reference/getlicensemanagercrossapplicationusers.md): Retrieve a paginated list of users across all applications in your SysAid account. Each user includes a calculated cross-app activity status and the applications they logged in to. - Indexes - [Get Indexes](https://developers.sysaid.com/reference/getindexes-1.md): Retrieve a list of available field indexes used across SysAid entities (such as service records, users, assets, etc.). Use this endpoint to dynamically discover which fields can be used for building… - [Get a List of Custom Fields](https://developers.sysaid.com/reference/getcustomfieldsinfolist.md): Retrieve a list of the custom fields you've set up in your SysAid account. - [Get indexes](https://developers.sysaid.com/reference/getindexes.md): Returns a list of key-value pairs (ID and caption) for entity-specific fields. - [Webhooks [beta]](https://developers.sysaid.com/reference/webhooks-1.md) - [Create a New Webhook Subscription](https://developers.sysaid.com/reference/createwebhook.md): Creates a new webhook subscriber with subscription for the specified events. - [Get Webhooks by Account ID](https://developers.sysaid.com/reference/getwebhooksbyaccountid.md): Retrieves a list of webhooks. - [Simulate Webhook Event](https://developers.sysaid.com/reference/simulatewebhookevent.md): Simulates a webhook event to test the webhook subscriber. - [Get Webhook Subscriber by ID](https://developers.sysaid.com/reference/getwebhooksubscriberbyid.md): Retrieves detailed information about a webhook subscriber. - [Delete Webhook Subscriber By ID](https://developers.sysaid.com/reference/deletewebhooksubscriberbyid.md): Deletes a webhook subscriber by ID. ## Pages - [Give Feedback](https://developers.sysaid.com/page/give-feedback.md) ## Changelog - [New Service Record Notes endpoints](https://developers.sysaid.com/changelog/new-service-record-notes-endpoints.md) - [New Create Multiple Contracts endpoint](https://developers.sysaid.com/changelog/new-create-multiple-contracts-endpoint.md) - [Fixed: Custom fields naming in Assets API docs](https://developers.sysaid.com/changelog/fixed-custom-fields-naming-in-assets-api-docs.md) - [Fixed: Assign service records to both Groups and Users](https://developers.sysaid.com/changelog/fixed-assign-service-records-to-both-groups-and-users.md) - [New Get Application Users endpoint](https://developers.sysaid.com/changelog/new-get-application-users-endpoint.md) - [New Custom Fields Guide](https://developers.sysaid.com/changelog/new-custom-fields-guide.md) - [New Service Record Activity Endpoint](https://developers.sysaid.com/changelog/new-service-record-activity-endpoint.md) - [New Contract Endpoints in License Manager](https://developers.sysaid.com/changelog/new-contract-endpoints-in-license-manager.md) - [Introducing the License Manager API](https://developers.sysaid.com/changelog/introducing-the-license-manager-api.md) - [Introducing Group Endpoints](https://developers.sysaid.com/changelog/introducing-group-endpoints.md)