Documents
Documents represent document records tracked in your CRM. They can be linked to relationships and used to manage document workflows.
Use the Activity_Document endpoint to manage documents. Documents inherit all fields from Activity.
Endpoints
List Documents
GET
/v1/odata/Activity_DocumentSingle Document
GET
/v1/odata/Activity_Document({id})Create Document
POST
/v1/odata/Activity_DocumentUpdate Document
PUT
/v1/odata/Activity_Document({id})Delete Document
DELETE
/v1/odata/Activity_Document({id})Fields
Inherited Fields (from Activity)
See Activity Fields for all inherited fields.
Relationships
| Relationship | Target Entity | Cardinality | Description |
|---|---|---|---|
| Relationship | Relationship | N:1 | Linked relation |
| Contact | Relation.Person.Contact | N:1 | Contact person |
| Phase | Datastore.Phase.ActivityDocument | N:1 | Document phase |
| Attachments | Attachment | 1:N | File attachments |
| LinkedActivities | Activity | 1:N | Linked activities |
Expanding Relationships
GET
/v1/odata/Activity_Document({id})?$expand=RelationshipNavigating Relationships
GET
/v1/odata/Activity_Document({id})/RelationshipFiltering Examples
GET
/v1/odata/Activity_Document?$filter=contains(Subject, '{Subject}')&$top={top}GET
/v1/odata/Activity_Document?$filter=IsClosed eq {IsClosed}&$top={top}GET
/v1/odata/Activity_Document?$filter=CreationDate gt {CreationDate}&$top={top}