Merge · Schema

Collection

# The Collection Object ### Description 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. ### Usage Example TODO

IntegrationsPlatformUnified APIAgent HandlerLLM Gateway

Properties

Name	Type	Description
id	string
remote_id	stringnull	The third-party API ID of the matching object.
created_at	string	The datetime that this object was created by Merge.
modified_at	string	The datetime that this object was modified by Merge.
name	stringnull	The collection's name.
description	stringnull	The collection's description.
access_level	object	The level of access a User has to the Collection and its sub-objects.
collection_type	object	The collection's type.
parent_collection	stringnull	The parent collection for this collection.
permissions	array
collection_url	stringnull	The 3rd party url of the Collection.
remote_created_at	stringnull	When the third party's collection was created.
remote_updated_at	stringnull	When the third party's collection was updated.
remote_was_deleted	boolean	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 cove
field_mappings	object
remote_data	arraynull

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Collection",
  "title": "Collection",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "remote_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "The third-party API ID of the matching object."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "The datetime that this object was created by Merge."
    },
    "modified_at": {
      "type": "string",
      "format": "date-time",
      "description": "The datetime that this object was modified by Merge."
    },
    "name": {
      "type": [
        "string",
        "null"
      ],
      "description": "The collection's name."
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "description": "The collection's description."
    },
    "access_level": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/CollectionAccessLevelEnum"
        },
        {
          "type": "null"
        }
      ],
      "description": "The level of access a User has to the Collection and its sub-objects."
    },
    "collection_type": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/CollectionTypeEnum"
        },
        {
          "type": "null"
        }
      ],
      "description": "The collection's type."
    },
    "parent_collection": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The parent collection for this collection."
    },
    "permissions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Permission"
      }
    },
    "collection_url": {
      "type": [
        "string",
        "null"
      ],
      "format": "uri",
      "description": "The 3rd party url of the Collection."
    },
    "remote_created_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "When the third party's collection was created."
    },
    "remote_updated_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "When the third party's collection was updated."
    },
    "remote_was_deleted": {
      "type": "boolean",
      "description": "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_mappings": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/CollectionFieldMappings"
        },
        {
          "type": "null"
        }
      ]
    },
    "remote_data": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "#/components/schemas/RemoteData"
      }
    }
  },
  "description": "# The Collection Object\n### Description\nThe `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.\n\n### Usage Example\nTODO"
}