For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Logo
Resources
Log inGet a demo
Get startedAPI referenceImplementation
Get startedAPI referenceImplementation
    • Overview
          • The Collection object
          • GET/collections
          • GET/collections/{collection_id}/viewers
          • GET/collections/{id}
UnifiedAgent HandlerGateway
UnifiedAgent HandlerGateway
Resources
Log inGet a demo
Common ModelsCollections

The Collection object

The Collection Object
1{
2  "id": "string",
3  "remote_id": "string",
4  "created_at": "2023-01-01T00:00:00Z",
5  "modified_at": "2023-01-01T00:00:00Z",
6  "name": "string",
7  "description": "string",
8  "access_level": "PRIVATE",
9  "collection_type": "LIST",
10  "parent_collection": "string",
11  "permissions": [
12    {
13      "id": "string",
14      "remote_id": "string",
15      "created_at": "2023-01-01T00:00:00Z",
16      "modified_at": "2023-01-01T00:00:00Z",
17      "effect": "ALLOWED",
18      "actions": [
19        "VIEW"
20      ],
21      "applied_to_users": [
22        "string"
23      ],
24      "applied_to_roles": [
25        "string"
26      ],
27      "applied_to_teams": [
28        "string"
29      ],
30      "applied_to_collections": [
31        "string"
32      ],
33      "remote_was_deleted": true,
34      "field_mappings": {}
35    }
36  ],
37  "collection_url": "string",
38  "remote_created_at": "2023-01-01T00:00:00Z",
39  "remote_updated_at": "2023-01-01T00:00:00Z",
40  "remote_was_deleted": true,
41  "field_mappings": {},
42  "remote_data": [
43    {
44      "path": "string",
45      "data": {}
46    }
47  ]
48}
Was this page helpful?
Previous

/attachments/meta/post

Next

/collections

Built with

The Collection object is used to represent one or more Tickets. There can be a hierarchy of Collections, in which a sub-collection belongs to a parent-collection.

idstringOptionalRead-onlyformat: "uuid"
remote_idstring or nullOptional

The third-party API ID of the matching object.

created_atdatetimeOptionalRead-only
The datetime that this object was created by Merge.
modified_atdatetimeOptionalRead-only
The datetime that this object was modified by Merge.
namestring or nullOptional
The collection's name.
descriptionstring or nullOptional
The collection's description.
access_levelenum or nullOptional

The level of access a User has to the Collection and its sub-objects.

  • PRIVATE - PRIVATE
  • COMPANY - COMPANY
  • PUBLIC - PUBLIC
  • PARENT_COLLECTION - PARENT_COLLECTION
Allowed values:
collection_typeenum or nullOptional

The collection's type.

  • LIST - LIST
  • PROJECT - PROJECT
Allowed values:
parent_collectionstring or nullOptionalformat: "uuid"
The parent collection for this collection.
permissionslist of objectsOptionalRead-only
collection_urlstring or nullOptionalformat: "uri"<=2000 characters
The 3rd party url of the Collection.
remote_created_atdatetime or nullOptional
When the third party's collection was created.
remote_updated_atdatetime or nullOptional
When the third party's collection was updated.
remote_was_deletedbooleanOptional

Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.

field_mappingsobject or nullOptionalRead-only
remote_datalist of objects or nullOptionalRead-only