Appearance

Get Collections ​

Endpoint ​

http
GET /unified/ticketing/collections/{id}
Integrations supported
  • Asana
  • Basecamp
  • Bitbucket
  • Help Scout
  • Hive
  • HubSpot
  • Jira
  • Linear
  • Microsoft Planner
  • Monday.com
  • Pivotal Tracker
  • Planhat
  • Productboard
  • Quickbase for Project Management
  • Shortcut
  • Teamwork Project Management
  • Todoist
  • Trello
  • Wrike
  • Zoho Projects

Path parameters ​

id
string
REQUIRED · 

The ID of the resource.

Example: 23423523

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_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
type
string

The type of the collection

All possible enum values:
  • Todoset
  • component
  • epic
  • iteration
  • kanban_board
  • milestone
  • product
  • project
  • section
  • tasklist
  • version
  • workflow
Enum support by integration
  • Jira
    • project
    • version
  • Basecamp
    • Todoset
    • kanban_board
  • Shortcut
    • project
    • epic
    • iteration
    • workflow
  • Zoho Projects
    • tasklist
    • milestone
  • Pivotal Tracker
    • project
    • epic
  • Todoist
    • project
    • section
  • Productboard
    • component
    • product
Required in
  • Basecamp
  • Jira
  • Pivotal Tracker
  • Productboard
  • Shortcut
  • Todoist
  • Zoho Projects
workspace
string
Integration specific notes
  • BasecampWorkspace associated with the ticket.
  • BitbucketThe unique identifier for the workspace
Required in
  • Basecamp
  • Bitbucket
  • Zoho Projects
id
string

The unique identifier for the workspace

name
string

The name of the workspace

organization
object
Supported in
  • Zoho Projects
id
string

The unique identifier for a organization.

Response Body ​

id
string
REQUIRED · 

The unique identifier for a collection

Supported in
  • Asana
  • Basecamp
  • Bitbucket
  • Help Scout
  • Hive
  • HubSpot
  • Jira
  • Linear
  • Microsoft Planner
  • Monday.com
  • Pivotal Tracker
  • Planhat
  • Productboard
  • Quickbase for Project Management
  • Shortcut
  • Teamwork Project Management
  • Todoist
  • Trello
  • Wrike
  • Zoho Projects
name
string

The name of the collection

Supported in
  • Asana
  • Basecamp
  • Bitbucket
  • Help Scout
  • Hive
  • HubSpot
  • Jira
  • Linear
  • Microsoft Planner
  • Monday.com
  • Pivotal Tracker
  • Planhat
  • Productboard
  • Shortcut
  • Teamwork Project Management
  • Todoist
  • Trello
  • Wrike
  • Zoho Projects
description
string

The description of the collection

Supported in
  • Asana
  • Basecamp
  • Bitbucket
  • Hive
  • Jira
  • Linear
  • Monday.com
  • Pivotal Tracker
  • Productboard
  • Shortcut
  • Teamwork Project Management
  • Wrike
type
string

The type of the collection

Supported in
  • Asana
  • Basecamp
  • Bitbucket
  • Help Scout
  • HubSpot
  • Jira
  • Linear
  • Monday.com
  • Pivotal Tracker
  • Shortcut
  • Todoist
  • Trello
  • Zoho Projects
parent_collection_id
string

The parent collection id

Supported in
  • Basecamp
  • Jira
  • Pivotal Tracker
  • Productboard
  • Todoist
  • Zoho Projects
urls
object[]

The URLs of the collection

Supported in
  • Basecamp
  • Bitbucket
  • Help Scout
  • Jira
  • Productboard
  • Todoist
  • Wrike
  • Zoho Projects
url
string

The URL of the collection

workspace
object
Supported in
  • Bitbucket
  • Hive
  • 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
  • Help Scout
  • Hive
  • Linear
  • Pivotal Tracker
  • Planhat
  • Productboard
  • Shortcut
  • Teamwork Project Management
  • Wrike
  • Zoho Projects
updated_at
string · date-time

The date and time when the collection was updated

Supported in
  • Basecamp
  • Bitbucket
  • Help Scout
  • Hive
  • Linear
  • Monday.com
  • Pivotal Tracker
  • Productboard
  • Shortcut
  • Teamwork Project Management
  • Wrike
  • 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.