Appearance

List Collections ​

Endpoint ​

http
GET /unified/ticketing/collections
Integrations supported
  • Airtable
  • Asana
  • Basecamp
  • Bitbucket
  • Enchant
  • Gorgias
  • Help Scout
  • Jira
  • Linear
  • Microsoft Planner
  • Monday.com
  • Planhat
  • Quickbase for Project Management
  • Shortcut
  • Teamwork Project Management
  • Trello
  • YouTrack
  • Zoho Projects

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

The unique identifier for the workspace

Required in
  • Airtable
Supported in
  • Asana
type
string

The type of the collection

All possible enum values:
  • epic
  • iteration
  • milestone
  • project
  • tasklist
  • version
  • workflow
Enum support by integration
  • Jira
    • project
    • version
  • Shortcut
    • project
    • epic
    • iteration
    • workflow
  • Zoho Projects
    • tasklist
    • milestone
Required in
  • Jira
  • Shortcut
  • Zoho Projects
parent_collection_id
string

The parent collection id

Supported in
  • Jira
  • Zoho Projects
workspace
object
Integration specific notes
  • BasecampWorkspace associated with the collections.
  • BitbucketThe unique identifier for the workspace
Required in
  • Basecamp
  • Bitbucket
  • Microsoft Planner
  • Trello
  • Zoho Projects
Supported in
  • Teamwork Project Management
id
string

The unique identifier for the workspace

name
string

The name of the workspace

sort_by
object

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

All possible enum values:
  • created_at
  • name
  • updated_at
Enum support by integration
  • Planhat
    • name
    • created_at
  • Zoho Projects
    • updated_at
    • created_at
Supported in
  • Gorgias
  • Planhat
  • Zoho Projects
created_at
string · date-time

The date and time when the collection was created

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

The date and time when the collection was updated

Supported in
  • Teamwork Project Management
  • Zoho Projects
organization
object
Required in
  • Zoho Projects
id
string

The unique identifier for a organization.

Response Body ​

result
object[]

List of Collections

id
string
REQUIRED · 

The unique identifier for a collection

Supported in
  • Airtable
  • Asana
  • Basecamp
  • Bitbucket
  • Enchant
  • Gorgias
  • Help Scout
  • Jira
  • Linear
  • Microsoft Planner
  • Monday.com
  • Planhat
  • Quickbase for Project Management
  • Shortcut
  • Teamwork Project Management
  • Trello
  • YouTrack
  • Zoho Projects
name
string

The name of the collection

Supported in
  • Airtable
  • Asana
  • Basecamp
  • Bitbucket
  • Enchant
  • Gorgias
  • Help Scout
  • Jira
  • Linear
  • Microsoft Planner
  • Monday.com
  • Planhat
  • Shortcut
  • Teamwork Project Management
  • Trello
  • YouTrack
  • Zoho Projects
description
string

The description of the collection

Supported in
  • Asana
  • Basecamp
  • Bitbucket
  • Gorgias
  • Jira
  • Linear
  • Monday.com
  • Shortcut
  • Teamwork Project Management
  • YouTrack
type
string

The type of the collection

Supported in
  • Asana
  • Basecamp
  • Bitbucket
  • Enchant
  • Gorgias
  • Help Scout
  • Jira
  • Linear
  • Monday.com
  • Shortcut
  • Trello
  • YouTrack
  • Zoho Projects
parent_collection_id
string

The parent collection id

Supported in
  • Basecamp
  • Jira
  • Zoho Projects
urls
object[]

The URLs of the collection

Supported in
  • Basecamp
  • Bitbucket
  • Gorgias
  • Help Scout
  • Jira
  • Zoho Projects
url
string

The URL of the collection

workspace
object
Supported in
  • Bitbucket
  • Microsoft Planner
  • Teamwork Project Management
  • Zoho Projects
id
string

The unique identifier for a workspace

name
string

The name of the workspace

created_at
string · date-time

The date and time when the collection was created

Supported in
  • Basecamp
  • Bitbucket
  • Gorgias
  • Linear
  • Planhat
  • Shortcut
  • Teamwork Project Management
  • Zoho Projects
updated_at
string · date-time

The date and time when the collection was updated

Supported in
  • Basecamp
  • Bitbucket
  • Linear
  • Monday.com
  • Shortcut
  • Teamwork Project Management
  • Zoho Projects
etag
string

The unique identifier for the specific version of the resource.

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