v18

latestOpenAPI 3.0.0raw.githubusercontent.com2024-11-18167108845.6 KB

ticketing/collections

Retrieve Collections

Retrieve Collections from any connected Ticketing software

get/ticketing/collections/{id}

Path parameters

idstring required

id of the collection you want to retrieve.

Query parameters

remote_databoolean

Set to true to include data from the original Ticketing software.

Headers

x-connection-tokenstring required

The connection token

Response

namestring nullable required

The name of the collection

descriptionstring nullable

The description of the collection

collection_typestring nullable

The type of the collection. Authorized values are either PROJECT or LIST

idstring nullable

The UUID of the collection

remote_idstring nullable

The id of the collection in the context of the 3rd Party

remote_dataobject nullable

The remote data of the collection in the context of the 3rd Party

created_atstring date-time nullable

The created date of the object

modified_atstring date-time nullable

The modified date of the object

Example response

{
  "name": "My Personal Collection",
  "description": "Collect issues",
  "collection_type": "PROJECT",
  "id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "remote_id": "id_1",
  "remote_data": {
    "fav_dish": "broccoli",
    "fav_color": "red"
  },
  "created_at": "2024-10-01T12:00:00Z",
  "modified_at": "2024-10-01T12:00:00Z"
}