API Reference
/
Connector API
/
Ticketing

Connector API

The Synqly Connector APIs provide a unifying interface and data model for all supported service Providers.

See the Synqly Overview for more information.

Download OpenAPI description
connectors.json
connectors.yaml
Languages
Servers
Synqly
https://api.synqly.com/

Assets

Operations

Edr

Operations

Hooks

Operations

Identity

Operations

Notifications

Operations

Operations (In Development)

In Development

This feature is actively being developed. Breaking changes should be expected.

Please contact us before using this feature.

Operations

Siem

Operations

Sink

Operations

Storage

Operations

Ticketing

Operations

List Remote Fields

Request

List all remote fields for all Projects in a ticketing integration. The response will include a list of fields for each issue type in the ticketing provider.

curl -i -X GET \
  https://api.synqly.com/v1/ticketing/remote-fields \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json
resultArray of objects(RemoteField)required
result[].​field_idstringrequired

Remote ID of the field.

result[].​field_scopestring(RemoteFieldScope)required
Enum"standard""integration_custom""project_custom""ticket_custom""unknown"
result[].​provider_field_namestringrequired

Name of field in the remote ticketing provider.

result[].​schemaobject(RemoteFieldSchema)
result[].​provider_field_pathstring or null

Path to the field in the remote ticketing provider. Uses dot notation for nested fields.

result[].​project_idstring or null

Project id to which this field is scoped to

cursorstringrequired

Cursor to use to retrieve the next page of results

metaobject(MetaResponse)
Response
application/json
{
  "result": [
    { … }
  ],
  "cursor": "string",
  "meta": {
    "stats": { … },
    "api": { … }
  }
}

List Projects

Request

Returns a list of Projects from the token-linked Integration. Tickets must be created and retrieved within the context of a specific Project.

Query
cursorstring or null

Cursor to use to retrieve the next page of results.

limitinteger or null

Number of Projects objects to return in this page. Defaults to 50.

curl -i -X GET \
  'https://api.synqly.com/v1/ticketing/projects?cursor=string&limit=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json
resultArray of objects(Project)required
result[].​idstringrequired

Unique identifier for this project. Use this id in the project field of a Ticket.

result[].​namestringrequired

Name of the project

result[].​unmappedobject(Object)

The Object type is used to represent an object with arbitrary fields. The keys are strings and the values are any type.

cursorstringrequired

Cursor to use to retrieve the next page of results

metaobject(MetaResponse)
Response
application/json
{
  "result": [
    { … }
  ],
  "cursor": "string",
  "meta": {
    "stats": { … },
    "api": { … }
  }
}

Query Tickets

Request

Returns a list of Ticket objects from the token-linked Integration.

Query
metaArray of strings or null

Add metadata to the response by invoking meta functions. Documentation for meta functions is available at https://docs.synqly.com/api-reference/meta-functions. Not all meta function are available at every endpoint.

cursorstring or null

Cursor to use to retrieve the next page of results.

limitinteger or null

Number of Account objects to return in this page. Defaults to 100.

orderArray of strings or null

Select a field to order the results by. Defaults to time. To control the direction of the sorting, append [asc] or [desc] to the field name. For example, name[desc] will sort the results by name in descending order. The ordering defaults to asc if not specified. May be used multiple times to order by multiple fields, and the ordering is applied in the order the fields are specified.

filterArray of strings or null

Filter results by this query. For more information on filtering, refer to our Filtering Guide. Defaults to no filter. If used more than once, the queries are ANDed together.

curl -i -X GET \
  'https://api.synqly.com/v1/ticketing/tickets?cursor=string&filter=string&limit=0&meta=string&order=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json
resultArray of objects(Ticket)required

list of results

result[].​idstring(Id)required
result[].​summarystringrequired

Ticket summary.

result[].​namestringrequired

Human-readable name for this resource

result[].​created_atstring(date-time)required

Time object was originally created

result[].​updated_atstring(date-time)required

Last time object was updated

result[].​creatorstring or null

User who created this ticket.

result[].​assigneestring or null

Who ticket is assigned to.

result[].​contactstring or null

Ticket contact information.

result[].​descriptionstring or null

Ticket description.

result[].​prioritystring(Priority)
Enum"URGENT""CRITICAL""HIGH""MEDIUM""MODERATE""LOW""PLANNING"
result[].​due_datestring or null(date-time)

The ticket's due date.

result[].​completion_datestring or null(date-time)

The ticket's complete date.

result[].​statusstring(Status)
result[].​projectstring(Id)
result[].​issue_typestring(IssueTypeId)

Unique identifier for an issue type

result[].​tagsArray of strings or null

Associate tags with Ticket

result[].​attachmentsArray of objects or null(AttachmentMetadata)

Metadata of attachments associated with the ticket

result[].​custom_fieldsobject or null

Custom fields for this ticket, keys are the custom field names.

result[].​unmappedobject(Object)

The Object type is used to represent an object with arbitrary fields. The keys are strings and the values are any type.

cursorstringrequired

Cursor to use to retrieve the next page of results

metaobject(MetaResponse)
Response
application/json
{
  "result": [
    { … }
  ],
  "cursor": "string",
  "meta": {
    "stats": { … },
    "api": { … }
  }
}

Vulnerabilities

Operations