Appearance

List Tickets ​

Endpoint ​

http
GET /unified/ticketing/tickets
Integrations supported
  • Airtable
  • Asana
  • Azure DevOps
  • Basecamp
  • Bitbucket
  • ClickUp
  • Freshdesk
  • GitLab
  • Gorgias
  • Help Scout
  • HubSpot
  • Intercom
  • Jira
  • Linear
  • Monday.com
  • Salesforce
  • Shortcut
  • Trello
  • YouTrack
  • Zendesk
  • Zoho Desk
Partial response integrations

For partial response integrations, you will need to fetch the individual resource using the "get" endpoint to get the full response object.

  • Zoho Desk

Query parameters ​

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

The format of the response.

  • unified will return the response with unified mappings applied.
  • raw will return the raw response from the remote API.
  • normalized will apply the unified mappings and return the data in a normalized format.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
Example: unified
truto_key_by
string

By default the result attribute is an array of objects. This parameter allows you to specify a field in each result objects to use as key, which transforms the result array into an object with the array items keyed by the field. This is useful for when you want to use the result as a lookup table.

Example: id
truto_ignore_limit
boolean

Ignores the limit query parameter.

truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar
collections
array

Collections associated with the ticket

Integration specific notes
  • Help ScoutCollections associated with the ticket
  • GorgiasCollections associated with the ticket
  • LinearCollections associated with the ticket
  • JiraCollections associated with the ticket
  • BasecampCollections associated with the ticket
  • AirtableCollections associated with the ticket
  • Monday.comCollections associated with the ticket
  • AsanaCollections associated with the ticket. One of collections, workspace or tags is required.
  • YouTrackCollections associated with the ticket
  • BitbucketThe unique identifier for a ticket
Required in
  • Airtable
  • Basecamp
  • Bitbucket
  • Monday.com
Supported in
  • Asana
  • Gorgias
  • Help Scout
  • HubSpot
  • Jira
  • Linear
  • Shortcut
  • YouTrack
updated_at
string · date-time

Time at which the ticket was last updated

Supported in
  • Asana
  • Azure DevOps
  • ClickUp
  • Freshdesk
  • Help Scout
  • HubSpot
  • Intercom
  • Jira
  • Linear
  • Shortcut
  • YouTrack
  • Zendesk
tags
array

Tags associated with the ticket

Integration specific notes
  • AsanaTags associated with the ticket. One of collections, workspace or tags is required.
  • ShortcutTags associated with the ticket
  • YouTrackTags associated with the ticket
Supported in
  • Asana
  • Azure DevOps
  • ClickUp
  • Freshdesk
  • GitLab
  • Help Scout
  • Intercom
  • Jira
  • Linear
  • Shortcut
  • Trello
  • YouTrack
  • Zendesk
name
string

The name of the ticket

Supported in
  • Asana
  • Azure DevOps
  • GitLab
  • Help Scout
  • Jira
  • Linear
  • Shortcut
  • Trello
  • YouTrack
assignee_id
string
Integration specific notes
  • Help ScoutThe unique identifier for a user
  • ClickUpThe unique identifier for the users assigned to the ticket
  • LinearThe unique identifier for the users assigned to the ticket
  • ZendeskThe unique identifier for the users assigned to the ticket
  • FreshdeskThe unique identifier for the users assigned to the ticket
  • JiraThe unique identifier for the users assigned to the ticket
Supported in
  • ClickUp
  • Freshdesk
  • Help Scout
  • Jira
  • Linear
  • Zendesk
status
object

The status of the ticket

Integration specific notes
  • BasecampStatus associated with the ticket. Required if collection type is "kanban_board"
  • YouTrackThe status of the ticket
Supported in
  • Azure DevOps
  • Basecamp
  • ClickUp
  • Freshdesk
  • GitLab
  • Help Scout
  • Intercom
  • Jira
  • Linear
  • Monday.com
  • Shortcut
  • Trello
  • YouTrack
  • Zendesk
id
string

The unique identifier for a status

name
string

The name of the status

All possible enum values:
  • active
  • all
  • archived
  • closed
  • completed
  • deleted
  • open
  • pending
  • resolved
  • spam
number
string

An optional ticket number maintained by the system.

Supported in
  • GitLab
  • Gorgias
  • Help Scout
  • YouTrack
description
string

Description of the ticket

Supported in
  • GitLab
  • Help Scout
  • Jira
  • Linear
  • Shortcut
  • Trello
  • YouTrack
created_at
string · date-time

Time at which the ticket was created

Supported in
  • Azure DevOps
  • ClickUp
  • Freshdesk
  • Help Scout
  • Intercom
  • Jira
  • Linear
  • Shortcut
  • YouTrack
  • Zendesk
contact_id
string

The unique identifier for a contact

Supported in
  • Gorgias
sort_by
object

The field to sort the resource by. Should be in format { fieldName: direction }. The direction can be asc or desc.

Supported in
  • Gorgias
  • YouTrack
created_at
string · date-time

The sort order of the tickets by created date.

All possible enum values:
  • asc
  • desc
Supported in
  • Gorgias
  • YouTrack
updated_at
string · date-time

The sort order of the tickets by updated date.

All possible enum values:
  • asc
  • desc
Supported in
  • Gorgias
  • YouTrack
completed_at
string · date-time

Time at which the ticket was completed

All possible enum values:
  • asc
  • desc
Supported in
  • YouTrack
collections
string

Collections associated with the ticket

All possible enum values:
  • asc
  • desc
Supported in
  • YouTrack
id
string

The unique identifier for a collection

name
string

The name of the collection

name
string

The name of the ticket

All possible enum values:
  • asc
  • desc
Supported in
  • YouTrack
number
string

An optional ticket number maintained by the system.

All possible enum values:
  • asc
  • desc
Supported in
  • YouTrack
created_by
string

User or contact who created the ticket

All possible enum values:
  • asc
  • desc
Supported in
  • YouTrack
id
string

The unique identifier for a user

name
string

The name of the user

type
string

The type of the user

All possible enum values:
  • user
  • contact
assignees
string

Users assigned to the ticket

All possible enum values:
  • asc
  • desc
Supported in
  • YouTrack
id
string

The unique identifier for a user

name
string

The name of the user

first_name
string

The first name of the user

last_name
string

The last name of the user

emails
object[]

The user's email addresses

email
string
REQUIRED · 

The user's email address

type
string

The type of email address

ticket_type
string

Type of the ticket

All possible enum values:
  • asc
  • desc
Supported in
  • YouTrack
id
string

The unique identifier for a ticket type

name
string

The name of the ticket type

status
string

The status of the ticket

All possible enum values:
  • asc
  • desc
Supported in
  • YouTrack
id
string

The unique identifier for a status

name
string

The name of the status

All possible enum values:
  • active
  • closed
  • open
  • pending
  • spam
  • resolved
  • archived
  • deleted
  • completed
priority
string

Priority of the ticket

All possible enum values:
  • asc
  • desc
Supported in
  • YouTrack
id
string

The unique identifier for a priority

name
string

The name of the priority

workspace_id
string

The unique identifier for the workspace

Required in
  • Airtable
  • Azure DevOps
  • ClickUp
due_date
string · date-time

Due date of the ticket

Supported in
  • ClickUp
  • Jira
  • Linear
  • Monday.com
  • Shortcut
completed_at
string · date-time

Time at which the ticket was completed

Supported in
  • Asana
  • Azure DevOps
  • ClickUp
  • Jira
  • Linear
  • Shortcut
  • YouTrack
created_by_id
string

The unique identifier for the user who created the ticket

Supported in
  • Linear
priority
object

Priority of the ticket

Supported in
  • Azure DevOps
  • Intercom
  • Jira
  • Linear
  • YouTrack
id
string

The unique identifier for a priority

name
string

The name of the priority

include
array

The side-loaded resources to include in the response. Only value supported is users

Supported in
  • Zendesk
ticket_type
object

Type of the ticket

Supported in
  • Azure DevOps
  • Jira
  • Shortcut
  • YouTrack
id
string

The unique identifier for a ticket type

name
string

The name of the ticket type

parent_ticket
object

Parent ticket associated for the ticket.

Supported in
  • Azure DevOps
  • Jira
id
string

The unique identifier for the parent_ticket

name
string

The name of the ticket

workspace
object

Workspace associated with the ticket

Integration specific notes
  • BasecampWorkspace associated with the ticket.
  • AsanaWorkspace associated with the ticket. If provided, assignee should also be provided.
  • BitbucketThe unique identifier for a workspace
Required in
  • Basecamp
  • Bitbucket
  • GitLab
Supported in
  • Asana
  • Trello
id
string

The unique identifier for the workspace.

name
string

The name of the workspace

assignee_name
string

The name of the user assigned to the ticket

Supported in
  • Monday.com
  • Trello
assignee
object
Integration specific notes
  • Azure DevOpsThe user assigned to the ticket
  • AsanaThe Users assigned to the ticket. Required if workspace is ALSO provided.
Supported in
  • Asana
  • Azure DevOps
id
string

The unique identifier for the users assigned to the ticket.

name
string

The name of the user

email
string

The email of the user

teams
object

Team associated with the ticket.

Supported in
  • Asana
id
string

The unique identifier for the team.

custom_fields
object

Custom fields associated with the ticket. If provided, workspace should also be provided.

Supported in
  • Asana
id
string

The unique identifier for the custom_field

assignees
array

Users assigned to the ticket

Supported in
  • GitLab
  • Shortcut
  • YouTrack
created_by
object

User or contact who created the ticket

Supported in
  • GitLab
  • Shortcut
  • YouTrack
id
string

The unique identifier for a user

name
string

The name of the user

type
string

The type of the user

All possible enum values:
  • contact
  • user
username
string

The username of the user who created the ticket

attachments
array

Attachments associated with the ticket

Supported in
  • YouTrack

Response Body ​

result
object[]

List of Tickets

id
string
REQUIRED · 

The unique identifier for a ticket

Supported in
  • Airtable
  • Asana
  • Azure DevOps
  • Basecamp
  • Bitbucket
  • ClickUp
  • Freshdesk
  • GitLab
  • Gorgias
  • Help Scout
  • HubSpot
  • Intercom
  • Jira
  • Linear
  • Monday.com
  • Salesforce
  • Shortcut
  • Trello
  • YouTrack
  • Zendesk
  • Zoho Desk
name
string

The name of the ticket

Supported in
  • Asana
  • Azure DevOps
  • Basecamp
  • Bitbucket
  • ClickUp
  • Freshdesk
  • GitLab
  • Gorgias
  • Help Scout
  • HubSpot
  • Intercom
  • Jira
  • Linear
  • Monday.com
  • Salesforce
  • Shortcut
  • Trello
  • YouTrack
  • Zendesk
  • Zoho Desk
number
string

An optional ticket number maintained by the system.

Supported in
  • GitLab
  • Gorgias
  • Help Scout
  • Linear
  • Salesforce
  • Shortcut
  • YouTrack
assignees
object[]

Users assigned to the ticket

Supported in
  • Asana
  • Azure DevOps
  • Basecamp
  • Bitbucket
  • ClickUp
  • Freshdesk
  • GitLab
  • Gorgias
  • Help Scout
  • HubSpot
  • Intercom
  • Jira
  • Linear
  • Salesforce
  • Shortcut
  • Trello
  • YouTrack
  • Zendesk
  • Zoho Desk
id
string

The unique identifier for a user

name
string

The name of the user

first_name
string

The first name of the user

last_name
string

The last name of the user

emails
object[]

The user's email addresses

email
string
REQUIRED · 

The user's email address

type
string

The type of email address

status
object

The status of the ticket

Supported in
  • Azure DevOps
  • Basecamp
  • Bitbucket
  • ClickUp
  • Freshdesk
  • GitLab
  • Gorgias
  • Help Scout
  • HubSpot
  • Intercom
  • Jira
  • Linear
  • Monday.com
  • Salesforce
  • Shortcut
  • Trello
  • YouTrack
  • Zendesk
  • Zoho Desk
id
string

The unique identifier for a status

name
string

The name of the status

All possible enum values:
  • active
  • closed
  • open
  • pending
  • spam
  • resolved
  • archived
  • deleted
  • completed
created_by
object

User or contact who created the ticket

Supported in
  • Azure DevOps
  • Basecamp
  • Bitbucket
  • ClickUp
  • GitLab
  • Gorgias
  • Help Scout
  • Intercom
  • Jira
  • Linear
  • Monday.com
  • Salesforce
  • Shortcut
  • YouTrack
  • Zendesk
id
string

The unique identifier for a user

name
string

The name of the user

type
string

The type of the user

All possible enum values:
  • user
  • contact
due_date
string · date-time

Due date of the ticket

Supported in
  • Asana
  • Basecamp
  • ClickUp
  • Freshdesk
  • GitLab
  • Jira
  • Linear
  • Shortcut
  • Trello
  • Zendesk
  • Zoho Desk
description
string

Description of the ticket

Supported in
  • Asana
  • Azure DevOps
  • Basecamp
  • Bitbucket
  • ClickUp
  • Freshdesk
  • GitLab
  • Gorgias
  • Help Scout
  • Intercom
  • Jira
  • Linear
  • Salesforce
  • Shortcut
  • Trello
  • YouTrack
  • Zendesk
workspace
object

Workspace associated with the ticket

Supported in
  • Azure DevOps
  • Basecamp
  • Bitbucket
  • GitLab
  • Trello
id
string

The unique identifier for a workspace

name
string

The name of the workspace

team
object

Team associated with the ticket

Supported in
  • Shortcut
id
string

The unique identifier for a team

name
string

The name of the team

collections
object[]

Collections associated with the ticket

Supported in
  • Asana
  • Basecamp
  • Bitbucket
  • ClickUp
  • Help Scout
  • HubSpot
  • Jira
  • Linear
  • Monday.com
  • Shortcut
  • Trello
  • YouTrack
id
string

The unique identifier for a collection

name
string

The name of the collection

ticket_type
object

Type of the ticket

Supported in
  • Asana
  • Azure DevOps
  • Bitbucket
  • Freshdesk
  • GitLab
  • Help Scout
  • Jira
  • Salesforce
  • Shortcut
  • YouTrack
  • Zendesk
id
string

The unique identifier for a ticket type

name
string

The name of the ticket type

contact
object

Contact associated with the ticket

Supported in
  • Basecamp
  • Freshdesk
  • Gorgias
  • Help Scout
  • HubSpot
  • Intercom
  • Salesforce
  • Zendesk
  • Zoho Desk
id
string

The unique identifier for a contact

first_name
string

The first name of the contact

last_name
string

The last name of the contact

name
string

The name of the contact

emails
object[]

The emails of the contact

email
string
REQUIRED · 

The email of the contact

type
string

The type of the email

parent_ticket
object

Parent ticket associated with the ticket

Supported in
  • Asana
  • Azure DevOps
  • ClickUp
  • Jira
  • Monday.com
  • Salesforce
  • YouTrack
id
string

The unique identifier for a ticket

name
string

The name of the ticket

attachments
object[]

Attachments associated with the ticket

Supported in
  • Asana
  • Intercom
  • Jira
  • Linear
  • YouTrack
id
string

The unique identifier for an attachment

file_name
string

The name of the attachment

file_url
string

The url of the attachment

tags
object[]

Tags associated with the ticket

Supported in
  • Asana
  • ClickUp
  • Freshdesk
  • GitLab
  • Gorgias
  • Help Scout
  • Intercom
  • Jira
  • Linear
  • Shortcut
  • Trello
  • YouTrack
  • Zendesk
id
string

The unique identifier for a tag

name
string

The name of the tag

created_at
string · date-time

Time at which the ticket was created

Supported in
  • Airtable
  • Asana
  • Azure DevOps
  • Basecamp
  • Bitbucket
  • ClickUp
  • Freshdesk
  • GitLab
  • Gorgias
  • Help Scout
  • HubSpot
  • Intercom
  • Jira
  • Linear
  • Monday.com
  • Salesforce
  • Shortcut
  • Trello
  • YouTrack
  • Zendesk
  • Zoho Desk
updated_at
string · date-time

Time at which the ticket was last updated

Supported in
  • Asana
  • Azure DevOps
  • Basecamp
  • Bitbucket
  • ClickUp
  • Freshdesk
  • GitLab
  • Gorgias
  • Help Scout
  • HubSpot
  • Intercom
  • Jira
  • Linear
  • Monday.com
  • Salesforce
  • Shortcut
  • Trello
  • YouTrack
  • Zendesk
completed_at
string · date-time

Time at which the ticket was completed

Supported in
  • Asana
  • Azure DevOps
  • Basecamp
  • ClickUp
  • GitLab
  • Gorgias
  • Help Scout
  • HubSpot
  • Intercom
  • Jira
  • Linear
  • Salesforce
  • Shortcut
  • YouTrack
  • Zoho Desk
ticket_url
string

URL of the ticket

Supported in
  • Asana
  • Azure DevOps
  • Basecamp
  • Bitbucket
  • GitLab
  • Help Scout
  • Jira
  • Linear
  • Monday.com
  • Shortcut
  • Trello
  • YouTrack
  • Zendesk
  • Zoho Desk
priority
object

Priority of the ticket

Supported in
  • Azure DevOps
  • Bitbucket
  • ClickUp
  • Freshdesk
  • Gorgias
  • Intercom
  • Jira
  • Linear
  • Salesforce
  • Trello
  • YouTrack
  • Zendesk
  • Zoho Desk
id
string

The unique identifier for a priority

name
string

The name of the priority

languages
string[]

Languages of the ticket

Supported in
  • Gorgias
is_unread
boolean

Whether the ticket is unread

Supported in
  • Gorgias
source
object
Supported in
  • Salesforce
id
string

The unique identifier for a source

name
string

The name of the source

remote_data
object

Raw data returned from the remote API call.

next_cursor
string

The cursor to use for the next page of results. Pass this value as next_cursor in the query parameter in the next request to get the next page of results.