Skip to main content

Documents

EntityActivityActivity.Document

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_Document

Single Document

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

Create Document

POST/v1/odata/Activity_Document

Update 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

RelationshipTarget EntityCardinalityDescription
RelationshipRelationshipN:1Linked relation
ContactRelation.Person.ContactN:1Contact person
PhaseDatastore.Phase.ActivityDocumentN:1Document phase
AttachmentsAttachment1:NFile attachments
LinkedActivitiesActivity1:NLinked activities

Expanding Relationships

GET/v1/odata/Activity_Document({id})?$expand=Relationship
GET/v1/odata/Activity_Document({id})/Relationship

Filtering 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}