Requirements

An active Farsight® admin account

Authorized API key

Limitations

API Usage Limits by Plan

Get All Tickets (GET /v1/tickets)

Go to: https://api.farsight.gg/swagger/index.html#/Tickets/Tickets_GetTickets

You can retrieve a list of all tickets created in your organization using this API. Once authorized, this call will return all tickets along with their data.

The following parameters are used to filter, sort, and paginate the list of tickets returned in the response. All parameters are optional unless otherwise noted.

Input Parameter	Type	Required	Definition
SearchQuery	integer	No	The ticket search query to search by ticket title or number.
status	array[string]	No	The ticket statuses to filter.
priority	array[string]	No	The ticket priorities to filter.
assignee	array[string]	No	The ticket assignees to filter.
supervisor	array[string]	No	The ticket supervisors to filter.
assetId	array[integer]	No	The IDs of the target assets to filter.
connectionId	array[integer]	No	The IDs of the target connections (sites) to filter.
sort	string	No	Fields used to sort the result. Composed by the name of the field followed by :asc or :desc. Example: id:asc.
Limit	integer	No	The number of items you want the API to return. It can range from 1 to 50 (Free) or 1 to 500 (Pro). The default value is set to 25.
Offset	integer	No	The index of the first item to return. Must be 0 or greater. It is set to 0 by default.

Create Ticket (POST /v1/tickets)

Go to: https://api.farsight.gg/swagger/index.html#/Tickets/Tickets_CreateTicket

You can create a new ticket using this API.

The following table shows the parameters you need to pass in the request. All parameters are required unless otherwise noted.

{
  "title": "string",
  "description": "string",
  "status": "Open",
  "priority": "Low",
  "startDate": "2025-11-06T14:52:35.328Z",
  "endDate": "2025-11-06T14:52:35.328Z",
  "assigneeEmail": "string",
  "supervisorEmail": "string",
  "connectionId": 0,
  "assetIds": [
    0
  ],
  "alarmIds": [
    "string"
  ],
  "eventIds": [
    0
  ],
  "manualEventIds": [
    0
  ]
}

Input Parameter	Type	Required	Definition
title	string	Yes	Title of the ticket
description	string	No	Description of the ticket
status	string	Yes	Status of the ticket, e.g., On Hold, In Progress etc.
priority	string	Yes	Priority of the ticket, e.g., Low, High etc.
startDate	string	No	Start date of the ticket
endDate	string	No	End date of the ticket
assigneeEmail	string	No	The organization user email for the ticket assignee
supervisorEmail	string	No	The organization user email for the ticket supervisor
connectionId	integer	Yes/No	The ID of the site to associate the ticket with. Either connectionId or assetIds is required.
assetsIds	integer	Yes/No	The IDs of the assets to associate the ticket with. Either connectionId or assetIds is required.
alarmIds	string	No	The IDs of the alarms to associate the ticket with.
eventIds	integer	No	The IDs of the logbook events to associate the ticket with.
manualEventIds	integer	No	The IDs of the logbook manual events to associate the ticket with.

Get One Ticket (GET /v1/tickets)

Go to: https://api.farsight.gg/swagger/index.html#/Tickets/Tickets_GetTicket

You can retrieve individual tickets created in your organization using this API. Once authorized, this call will return a ticket along with its data.

The following parameter is used to retrieve a ticket.

Input Parameter	Type	Required	Definition
id	integer	Yes	The ID of the ticket you want to return.

Update a Ticket (PUT /v1/tickets)

Go to: https://api.farsight.gg/swagger/index.html#/Tickets/Tickets_UpdateTicket

You can update an existing ticket using this API. The ID of the ticket is mandatory.

Input Parameter	Type	Required	Definition
id	integer	Yes	The ID of the ticket you want to update.

The following shows the ticket parameters you can update:

{
  "title": "string",
  "description": "string",
  "status": "Open",
  "priority": "Low",
  "startDate": "2025-11-06T14:52:35.328Z",
  "endDate": "2025-11-06T14:52:35.328Z",
  "assigneeEmail": "string",
  "supervisorEmail": "string",
  "connectionId": 0,
  "assetIds": [
    0
  ],
  "alarmIds": [
    "string"
  ],
  "eventIds": [
    0
  ],
  "manualEventIds": [
    0
  ]
}

Input Parameter	Type	Required	Definition
title	string	Yes	Title of the ticket
description	string	No	Description of the ticket
status	string	Yes	Status of the ticket, e.g., On Hold, In Progress etc.
priority	string	Yes	Priority of the ticket, e.g., Low, High etc.
startDate	string	No	Start date of the ticket
endDate	string	No	End date of the ticket
assigneeEmail	string	No	The organization user email for the ticket assignee
supervisorEmail	string	No	The organization user email for the ticket supervisor
connectionId	integer	Yes/No	The ID of the site to associate the ticket with. Either connectionId or assetIds is required.
assetsIds	integer	Yes/No	The IDs of the assets to associate the ticket with. Either connectionId or assetIds is required.
alarmIds	string	No	The IDs of the alarms to associate the ticket with.
eventIds	integer	No	The IDs of the logbook events to associate the ticket with.
manualEventIds	integer	No	The IDs of the logbook manual events to associate the ticket with.

Delete Ticket (GET /v1/tickets)

Go to: https://api.farsight.gg/swagger/index.html#/Tickets/Tickets_DeleteTicket

You can delete individual tickets created in your organization using this API.

The following parameter is used to delete a ticket.

Input Parameter	Type	Required	Definition
id	integer	Yes	The ID of the ticket you want to delete.

Farsight® Tickets API