Merge · Schema

Attachment

# The Attachment Object ### Description The `Attachment` object is used to represent a file attached to a candidate. ### Usage Example Fetch from the `LIST Attachments` endpoint and view attachments accessible by a company.

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.
file_name	stringnull	The attachment's name.
file_url	stringnull	The attachment's url.
candidate	stringnull
attachment_type	object	The attachment's type.
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/Attachment",
  "title": "Attachment",
  "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."
    },
    "file_name": {
      "type": [
        "string",
        "null"
      ],
      "description": "The attachment's name."
    },
    "file_url": {
      "type": [
        "string",
        "null"
      ],
      "format": "uri",
      "description": "The attachment's url."
    },
    "candidate": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid"
    },
    "attachment_type": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/AttachmentTypeEnum"
        },
        {
          "type": "null"
        }
      ],
      "description": "The attachment's type."
    },
    "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/AttachmentFieldMappings"
        },
        {
          "type": "null"
        }
      ]
    },
    "remote_data": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "#/components/schemas/RemoteData"
      }
    }
  },
  "description": "# The Attachment Object\n### Description\nThe `Attachment` object is used to represent a file attached to a candidate.\n### Usage Example\nFetch from the `LIST Attachments` endpoint and view attachments accessible by a company."
}