The Collection object

{
  "id": "string",
  "remote_id": "string",
  "created_at": "2023-01-01T00:00:00Z",
  "modified_at": "2023-01-01T00:00:00Z",
  "name": "string",
  "description": "string",
  "access_level": "PRIVATE",
  "collection_type": "LIST",
  "parent_collection": "string",
  "permissions": [
    {
      "id": "string",
      "remote_id": "string",
      "created_at": "2023-01-01T00:00:00Z",
      "modified_at": "2023-01-01T00:00:00Z",
      "effect": "ALLOWED",
      "actions": [
        "VIEW"
      ],
      "applied_to_users": [
        "string"
      ],
      "applied_to_roles": [
        "string"
      ],
      "applied_to_teams": [
        "string"
      ],
      "applied_to_collections": [
        "string"
      ],
      "remote_was_deleted": true,
      "field_mappings": {
        "organization_defined_targets": {
          "string": {}
        },
        "linked_account_defined_targets": {
          "string": {}
        }
      }
    }
  ],
  "collection_url": "string",
  "remote_created_at": "2023-01-01T00:00:00Z",
  "remote_updated_at": "2023-01-01T00:00:00Z",
  "remote_was_deleted": true,
  "field_mappings": {
    "organization_defined_targets": {
      "string": {}
    },
    "linked_account_defined_targets": {
      "string": {}
    }
  },
  "remote_data": [
    {
      "path": "string",
      "data": {}
    }
  ]
}

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](https://docs.merge.dev/integrations/hris/supported-features/).

field_mappingsobject or nullOptionalRead-only

remote_datalist of objects or nullOptionalRead-only