Back

GET dialogs?ancestorType={ancestorType}&tz={tz}

Returns all dialogs for your site, can be filtered by ancestor type by adding ?ancestorType=

Request Information

URI Parameters

System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList
ancestorType integer

Ancestor Type of the dialog, Organization = 4, Department = 56, Project = 15, Individual = 39
tz string

Optional parameter to set timezone information.

Body Parameters

None.

Response Information

Resource Description (Dialog)

System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList
ID globally unique identifier Required on Update

ID of the given Dialog.
AncestorID globally unique identifier Required on Create

ID of the ancestor of the given dialog.
DialogDate date Required

Date the given dialog was created.
Name string

Name of the given dialog. (Max length 255 characters)
Location string

Location of the given dialog. (Max length 50 characters)
Agenda string

Agenda of the given dialog.
SiteID globally unique identifier ReadOnly

ID of the site for the given dialog.
AncestorType byte ReadOnly

Ancestor type (organization, individual, project, or task) of the given dialog.
Deleted boolean ReadOnly

Deleted status of the given dialog.
DeletedByRef boolean ReadOnly

Deleted by reference status of the given dialog.
Created date ReadOnly

Date that the given dialog was created.
CreatedBy globally unique identifier ReadOnly

ID of the individual that created the given dialog.
Updated date ReadOnly

Date the given dialog was last updated.
UpdatedBy globally unique identifier ReadOnly

ID of the individual that last updated the given dialog.
Template boolean ReadOnly

Indicates the given dialog is a template.
Draft boolean ReadOnly

Indicates the given dialog is a Draft.
LastCommentDate date ReadOnly

Date of the most recent comment for the given dialog.
LastCommentByID globally unique identifier ReadOnly

ID of the individual who posted the most recent comment for the given dialog.
LastCommentBy string ReadOnly

Name of the individual who posted the most recent comment for the given dialog.
LastComment string ReadOnly

Body of the most recent comment for the given dialog.
CanRead boolean ReadOnly

Read security setting for the object based on the current logged in user.
CanUpdate boolean ReadOnly

Update security setting for the object based on the current logged in user.
CanDelete boolean ReadOnly

Delete security setting for the object based on the current logged in user.
CanDelegate boolean ReadOnly

Delegate security setting for the object based on the current logged in user.
RowType integer ReadOnly

Row Type of the dialog (9 = Org Dialog, 25 = Project Dialog, 38 Individual Dialog,
DialogOccurred boolean ReadOnly

This denotes if the system considers the dialog completed or not. For the system to consider it completed a dialog must have either a comment or a follow up task.

Response Formats

application/xml, text/xml

Sample
<Dialog xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4">
  <ID>f1c3e1f2-448a-4a6f-bc61-2c5e815fe8cd</ID>
  <AncestorID>5a1f09d6-7041-4362-8f93-1f61f1d46133</AncestorID>
  <DialogDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2026-02-20T16:22:11.9586808Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </DialogDate>
  <Name>sample string 2</Name>
  <Location>sample string 3</Location>
  <Agenda>sample string 4</Agenda>
  <SiteID>96ff5374-1035-464d-af50-23d4fd64f7fe</SiteID>
  <AncestorType>64</AncestorType>
  <Deleted>true</Deleted>
  <DeletedByRef>true</DeletedByRef>
  <Created>2026-02-20T16:22:11.9586808+00:00</Created>
  <CreatedBy>d629e19a-5503-4d1b-972e-860ab24a36a6</CreatedBy>
  <Updated>2026-02-20T16:22:11.9586808+00:00</Updated>
  <UpdatedBy>c68fdd85-c58b-4cac-a392-e10024c5a1d5</UpdatedBy>
  <Template>true</Template>
  <Draft>true</Draft>
  <LastCommentDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2026-02-20T16:22:11.9586808Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </LastCommentDate>
  <LastCommentByID>9c81874f-e449-4acb-bf91-58ba2ac88dfa</LastCommentByID>
  <LastCommentBy>sample string 5</LastCommentBy>
  <LastComment>sample string 6</LastComment>
  <CanRead>true</CanRead>
  <CanUpdate>true</CanUpdate>
  <CanDelete>true</CanDelete>
  <CanDelegate>true</CanDelegate>
  <RowType>1</RowType>
  <DialogOccurred>true</DialogOccurred>
</Dialog>

application/json, text/json

Sample
{
  "ID": "f1c3e1f2-448a-4a6f-bc61-2c5e815fe8cd",
  "AncestorID": "5a1f09d6-7041-4362-8f93-1f61f1d46133",
  "DialogDate": "2026-02-20T16:22:11.9586808+00:00",
  "Name": "sample string 2",
  "Location": "sample string 3",
  "Agenda": "sample string 4",
  "SiteID": "96ff5374-1035-464d-af50-23d4fd64f7fe",
  "AncestorType": 64,
  "Deleted": true,
  "DeletedByRef": true,
  "Created": "2026-02-20T16:22:11.9586808+00:00",
  "CreatedBy": "d629e19a-5503-4d1b-972e-860ab24a36a6",
  "Updated": "2026-02-20T16:22:11.9586808+00:00",
  "UpdatedBy": "c68fdd85-c58b-4cac-a392-e10024c5a1d5",
  "Template": true,
  "Draft": true,
  "LastCommentDate": "2026-02-20T16:22:11.9586808+00:00",
  "LastCommentByID": "9c81874f-e449-4acb-bf91-58ba2ac88dfa",
  "LastCommentBy": "sample string 5",
  "LastComment": "sample string 6",
  "CanRead": true,
  "CanUpdate": true,
  "CanDelete": true,
  "CanDelegate": true,
  "RowType": 1,
  "DialogOccurred": true
}