Appearance

List Attachments ​

Endpoint ​

http
GET /unified/ticketing/attachments
Integrations supported
  • Asana
  • Bitbucket
  • Gorgias
  • Help Scout
  • Shortcut

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
ticket_id
string

The ticket id to which the attachment belongs

Required in
  • Asana
  • Gorgias
  • Help Scout
ticket
object

The unique identifier for a ticket

Required in
  • Bitbucket
workspace
object

The unique identifier for a workspace

Required in
  • Bitbucket
collections
array

The unique identifier for a ticket

Required in
  • Bitbucket

Response Body ​

result
object[]

List of Attachments

id
string

The unique identifier for the attachment

Supported in
  • Asana
  • Bitbucket
  • Help Scout
  • Shortcut
file_name
string

The attachment's name.

Supported in
  • Asana
  • Bitbucket
  • Gorgias
  • Help Scout
  • Shortcut
ticket_id
string

The ticket id to which the attachment belongs

Supported in
  • Asana
  • Bitbucket
  • Gorgias
  • Help Scout
  • Shortcut
file_url
string

The URL to download the attachment

Supported in
  • Asana
  • Bitbucket
  • Gorgias
  • Help Scout
  • Shortcut
content_type
string

The content type of the attachment

Supported in
  • Gorgias
  • Help Scout
  • Shortcut
uploaded_by
string

The user who uploaded the attachment

Supported in
  • Shortcut
uploaded_by_type
string

The type of the user who uploaded the attachment

Supported in
  • Shortcut
created_at
string · date-time

The time when the attachment was created

Supported in
  • Asana
  • Shortcut
updated_at
string · date-time

The time when the attachment was updated

Supported in
  • Shortcut
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.