Kickserv APIv2 - Attchments Object

This documention is neither written nor endorsed by Kickserv. It has not been reviewed by Kickserv for accuracy and the API is entirely unsupported. It may work, it may not. You are responsible for anything that you do using the API and Kickserv can't undo it for you. Use at your own risk.

Mouseover the JSON key to see a brief description of each key. Keys that either haven't been identified (or that we haven't gotten around to adding yet) will show 'XXX'. Keys that are light gray are obsolete/legacy but still are returned in API responses.

Attachments can be added to, and downloaded from, to jobs both through the web UI or via the API. As far as I'm aware the attachment endpoints are some of the things only accessible using APIv3 and as such they're not covered in this document. Other than the obvious use of uploading and downloading attachments we've used the attachment endpoints to make attachments accessible from custom templates directly or using the data from them to manipulate a job. That being said, there's a lot that remains unexplored with them.

If you spot a mistake or know the purpose of an undescribed key please let us know by emailing kickservapi@veildg.com.

Back to object map list

[{
"id": 444444,
"account_id": 999,
"customer_id": null,
"job_id": 34343434,
"description": "Document purchased from passing wizard",
"s3": true,
"created_at": "2022-04-21T15:27:36-04:00",
"updated_at": "2022-04-21T15:27:36-04:00",
"data_file_name": "image8.jpeg",
"data_content_type": "image/jpeg",
"data_file_size": 1948611,
"data_updated_at": null,
"note_id": null,
"deleted_at": null,
"public": null,
"attachable_id": null,
"purpose": null,
"has_pricing_info": null,
"request_id": null,
"data": {
"url": "https://someurl/file.txt",
"thumb_url": "https://someurl/filethumbnail.jpg",
"service_thumb_url": "https://someurl/servicethumb.jpg
}
}]