Attachment Details

Parameter	Mandatory	Description	Examples	More Info
API	Yes	The API area	attachments.json
General	Yes	Parameters described in overview	`Authorization: Bearer <access_token>` header — see Synergist API Authentication	Structure of an API call
Model Structure	Yes	Name of model required	modelstructure=attachmentdetails	Using data models
View	No	Stored filter applied		Using views
Sort	No	Change the view's default sort order	sort=CLIENT	Sorting
Filters	No	Filter by a key field		Filters
Company	Yes	The company number	company=1
Identifier	Yes	Attachment ID or UUID	attachmentid=5463

Example request (OAuth 2.0):

Authorization: Bearer <access_token>
http://<SERVER>/jsonapi/attachments.json?company=1&version=6&&style=modeldata&modelstructure=attachmentdetails&attachmentid=7333

Example request (legacy username/password):

http://<SERVER>/jsonapi/attachments.json?company=1&version=6&&style=modeldata&modelstructure=attachmentdetails&attachmentid=7333&user=<username>&password=<password>

Example response:

{
  "responsecode": 1,
  "responsestatus": "OK",
  "errorcode": 0,
  "errormessage": "",
  "totalrows": 1,
  "totalpages": 1,
  "responsemessage": "",
  "pagerows": 0,
  "pagenumber": 1,
  "success": true,
  "synapiversion": 3.8,
  "data": [
    {
      "attachmentUuid": "A90F2EC8D64E404F96587CE76658C56E",
      "attachmentTimestampModified": 1614954315,
      "attachmentRecordVersionNumber": 0,
      "attachmentPath": "",
      "attachmentSizeDescription": "2.88 K",
      "attachmentDescription": "image.png",
      "attachmentMode": "API",
      "attachmentApplicationName": "",
      "attachmentID": 7333,
      "attachmentDocumentName": "image_7333.png",
      "attachmentOriginalFilename": "image.png",
      "attachmentWinPathDocument": "\\\\DEV\\Syndev\\CRM\\Company 16\\Client 16_NU100\\16_X050028\\",
      "attachmentMacPathDocument": "Syndev:CRM:Company 16:Client 16_NU100:16_X050028:",
      "attachmentServerPathDocument": "c:\\syndev\\CRM\\Company 16\\Client 16_NU100\\16_X050028\\",
      "attachmentPrivate": false,
      "attachmentDocumentSize": 2944,
      "attachmentTemplateUsed": "",
      "attachmentCreationDate": "2021-03-05",
      "attachmentCreationTime": "14:25:15",
      "attachmentCreatedByUserID": 5,
      "attachmentCreatedByFullName": "Mike Pender",
      "attachmentVisibility": ""
    }
  ]
}