Attachments
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/AttachmentSingle Attachment
GET
/v1/odata/Attachment({id})Create Attachment
POST
/v1/odata/AttachmentUpdate Attachment
PUT
/v1/odata/Attachment({id})Delete Attachment
DELETE
/v1/odata/Attachment({id})Fields
Attachment Fields
| Field | Type | Description |
|---|---|---|
Description | String | Attachment description |
ContentId | String | Content identifier |
Version | String | Version number |
IsVisibleInSupportPortal | Boolean | Whether visible in the support portal |
Relationships
| Relationship | Target Entity | Cardinality | Description |
|---|---|---|---|
| File | File | N:1 | The file content |
| Offer | Activity.Offer | N:1 | Linked quote/offer |
| Invoice | Activity.Invoice | N:1 | Linked invoice |
| Document | Activity.Document | N:1 | Linked document |
| ProjectMilestone | ProjectMilestone | N:1 | Linked project milestone |
| AttachmentsBasedOnThis | Attachment | N:1 | Attachment this one is based on |
| BaseAttachment | Attachment | 1:N | Attachments based on this one |
Expanding Relationships
GET
/v1/odata/Attachment({id})?$expand=FileNavigating Relationships
GET
/v1/odata/Attachment({id})/FileFiltering 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}