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 Attachment object
          • GET/attachments
          • POST/attachments
          • GET/attachments/{id}
          • GET/attachments/meta/post
UnifiedAgent HandlerGateway
UnifiedAgent HandlerGateway
Resources
Log inGet a demo
Common ModelsAttachments

The Attachment object

The Attachment 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 "file_name": "string",
7 "file_url": "string",
8 "candidate": "string",
9 "attachment_type": "RESUME",
10 "remote_was_deleted": true,
11 "field_mappings": {},
12 "remote_data": [
13 {
14 "path": "string",
15 "data": {}
16 }
17 ]
18}
Was this page helpful?
Previous

/applications/meta/post

Next

/attachments

Built with

The Attachment object is used to represent a file attached to a candidate.

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.
file_namestring or nullOptional
The attachment's name.
file_urlstring or nullOptionalformat: "uri"<=2000 characters
The attachment's url.
candidatestring or nullOptionalformat: "uuid"
attachment_typeenum or nullOptional

The attachment's type.

  • RESUME - RESUME
  • COVER_LETTER - COVER_LETTER
  • OFFER_LETTER - OFFER_LETTER
  • OTHER - OTHER
Allowed values:
remote_was_deletedbooleanOptionalRead-only

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