Skip to main content

Attachments

EntityAttachment

Attachments represent files linked to entities in TribeCRM. They can be attached to relations, activities, project milestones, and more. Each attachment references a file and can have a description and version.

Use the Attachment endpoint to query and manage attachments. You can also access them via the Attachments navigation property on any entity.

Endpoints

List Attachments

GET/v1/odata/Attachment

Single Attachment

GET/v1/odata/Attachment({id})

Create Attachment

POST/v1/odata/Attachment

Update Attachment

PUT/v1/odata/Attachment({id})

Delete Attachment

DELETE/v1/odata/Attachment({id})

Fields

Attachment Fields

FieldTypeDescription
DescriptionStringAttachment description
ContentIdStringContent identifier
VersionStringVersion number
IsVisibleInSupportPortalBooleanWhether visible in the support portal

Relationships

RelationshipTarget EntityCardinalityDescription
FileFileN:1The file content
OfferActivity.OfferN:1Linked quote/offer
InvoiceActivity.InvoiceN:1Linked invoice
DocumentActivity.DocumentN:1Linked document
ProjectMilestoneProjectMilestoneN:1Linked project milestone
AttachmentsBasedOnThisAttachmentN:1Attachment this one is based on
BaseAttachmentAttachment1:NAttachments based on this one

Expanding Relationships

GET/v1/odata/Attachment({id})?$expand=File
GET/v1/odata/Attachment({id})/File

Filtering Examples

GET/v1/odata/Attachment?$filter=contains(Description, '{Description}')&$top={top}
GET/v1/odata/Attachment?$filter=Version eq '{Version}'&$top={top}
GET/v1/odata/Attachment?$filter=IsVisibleInSupportPortal eq {IsVisibleInSupportPortal}&$top={top}
GET/v1/odata/Attachment?$filter=CreationDate gt {CreationDate}&$top={top}