Get a filtered list of all followups.
get
/social/api/v1/followups
Request
Supported Media Types
- application/json
Specify a filter to query.
Root Schema : XV1FollowupFilterInfo
Type:
object
V1 Followup Filter Information DTO.
Show Source
-
excludeSelfAssigned(optional):
boolean
Exclude followups where the target user is both the assigner and assignee.
-
includeAssignee(optional):
boolean
Include followups assigned to the current user. The includeAssignee or includeAssigner field or both must be specified as true. Both false is the same as both true. This field is used only if both includeAssignees and includeAssigners are null.
-
includeAssignees(optional):
array includeAssignees
Include specified followups assignees. The includeAssignees or includeAssigners field or both must be specified. If both fields are null, fields includeAssignee and includeAssigner are used.
-
includeAssigner(optional):
boolean
Include followups assigned by the current user. The includeAssignee or includeAssigner field or both must be specified as true. Both false is the same as both true. This field is used only if both includeAssignees and includeAssigners are null.
-
includeAssigners(optional):
array includeAssigners
Include specified followups assigners. The includeAssignees or includeAssigners field or both must be specified. If both fields are null fields, includeAssignee and includeAssigner are used.
-
includeClosed(optional):
boolean
Include closed followups. The includeOpen or includeClosed field or both must be specified as true. Both false is the same as includeOpen true.
-
includeNoReply(optional):
boolean
Include no-reply followups. The includeReply or includeNoReply field or both must be specified as true. Both false is the same as both true.
-
includeOpen(optional):
boolean
Include open followups. The includeOpen or includeClosed field or both must be specified as true. Both false is the same as includeOpen true.
-
includeRead(optional):
boolean
Include read followups. The includeRead or includeUnread field or both must be specified as true. Both false is the same as both true.
-
includeReply(optional):
boolean
Include reply followups. The includeReply or includeNoReply field or both must be specified as true. Both false is the same as both true.
-
includeTypes(optional):
array includeTypes
Include specified followups types. If not specified, all types of followups are returned.
-
includeUnread(optional):
boolean
Include unread followups. The includeRead or includeUnread field or both must be specified as true. Both false is the same as both true.
-
sortField(optional):
object XV1FollowupSortField
-
sortOrderDescending(optional):
boolean
Sort is descending.
Nested Schema : includeAssignees
Type:
array
Include specified followups assignees. The includeAssignees or includeAssigners field or both must be specified. If both fields are null, fields includeAssignee and includeAssigner are used.
Show Source
-
Array of:
An object's unique identifier from a long integer representation.
Nested Schema : includeAssigners
Type:
array
Include specified followups assigners. The includeAssignees or includeAssigners field or both must be specified. If both fields are null fields, includeAssignee and includeAssigner are used.
Show Source
-
Array of:
An object's unique identifier from a long integer representation.
Nested Schema : includeTypes
Type:
array
Include specified followups types. If not specified, all types of followups are returned.
Show Source
Nested Schema : XV1FollowupSortField
Type:
Show Source
object
-
field(optional):
string
Allowed Values:
[ "FOLLOWUP_CHAT_DATE", "FOLLOWUP_CREATED_DATE", "FOLLOWUP_RECENT_ACTIVITY", "FOLLOWUP_TYPE" ]
V1 Followup Sort Fields.
Nested Schema : XV1FollowupType
Type:
Show Source
object
-
field(optional):
string
Allowed Values:
[ "FOR_YOUR_INFORMATION", "PLEASE_REPLY", "PLEASE_REPLY_URGENT" ]
V1 Followup Types.
Response
Supported Media Types
- application/json
200 Response
Successful operation.
Root Schema : XV1FollowupListInfo
Type:
object
V1 Followup List Information DTO.
Show Source
-
hasMore(optional):
boolean
If true, there are more items to be returned.
-
items(optional):
array items
The followups being returned.
-
nextURL(optional):
string(url)
Next page URL for the list. Null if this is the last page.
-
previousURL(optional):
string(url)
Previous page URL for the list. Null if this is the first page.
-
total(optional):
integer(int32)
If specified, this is the total number of available items. Null if the total is unknown.
Nested Schema : items
Type:
array
The followups being returned.
Show Source
-
Array of:
object XV1FollowupInfo
V1 Followup Information DTO.
Nested Schema : XV1FollowupInfo
Type:
object
V1 Followup Information DTO.
Show Source
-
altitude(optional):
number(double)
The object's altitude.
-
assigneeDisplayName(optional):
string
The display name of the user this followup is assigned to.
-
assigneeID(optional):
An object's unique identifier from a long integer representation.
-
assigneeName(optional):
string
The name of the user this followup is assigned to.
-
assigneeURL(optional):
string
A URL to the user this followup is assigned to.
-
assignerDisplayName(optional):
string
The display name of the user who assigned this followup.
-
assignerID(optional):
An object's unique identifier from a long integer representation.
-
assignerName(optional):
string
The name of the user who assigned this followup.
-
assignerURL(optional):
string(url)
A URL to the user who assigned this followup.
-
collectionURL(optional):
string(url)
A URL to this object's containing collection.
-
conversationURL(optional):
string(url)
A URL to this object's containing conversation.
-
createdByID(optional):
An object's unique identifier from a long integer representation.
-
createdByURL(optional):
string(url)
A URL to the user that created this object.
-
createdByUserDisplayName(optional):
string
The display name of the user that created this object.
-
createdByUserName(optional):
string
The name of the user that created this object.
-
createdDate(optional):
string(date)
The date this object was created.
-
createdDateInISO8601Format(optional):
string
The date this object was created, in ISO 8601 format.
-
displayName(optional):
string
The display name of this object.
-
followupType(optional):
object XV1FollowupType
-
id(optional):
An object's unique identifier from a long integer representation.
-
isOpen(optional):
boolean
Whether this followup is open or closed.
-
isRead(optional):
boolean
Whether this followup is read.
-
isRemoved(optional):
boolean
True if this message has been removed.
-
isReply(optional):
boolean
Whether this followup has been replied to.
-
latitude(optional):
number(double)
The object's latitude.
-
longitude(optional):
number(double)
The object's longitude.
-
messageURL(optional):
string(url)
A URL to the message this followup is set on.
-
modifiedByID(optional):
An object's unique identifier from a long integer representation.
-
modifiedByURL(optional):
string(url)
A URL to the user that last modified this object.
-
modifiedByUserDisplayName(optional):
string
The display name of the user that last modified this object.
-
modifiedByUserName(optional):
string
The name of the user that last modified this object.
-
modifiedDate(optional):
string(date)
The date this object was last modified.
-
modifiedDateInISO8601Format(optional):
string
The date this object was last modified, in ISO 8601 format.
-
name(optional):
string
The name of this object.
-
objectType(optional):
string
The type of this object.
-
openDate(optional):
string(date)
When the open/close state last changed.
-
openDateInISO8601Format(optional):
string
When the open/close state last changed, in ISO 8601 format.
-
openURL(optional):
string(url)
A URL to the user who last changed the open/close state.
-
readDate(optional):
string(date)
When the read state last changed.
-
readDateInISO8601Format(optional):
string
When the read state last changed, in ISO 8601 format.
-
removedByID(optional):
An object's unique identifier from a long integer representation.
-
removedByURL(optional):
string(url)
A URL to the user that last removed this object.
-
removedByUserDisplayName(optional):
string
The display name of the user that last removed this object.
-
removedByUserName(optional):
string
The name of the user that last removed this object.
-
removedDate(optional):
string(date)
The date this object was removed.
-
removedDateInISO8601Format(optional):
string
The date this object was removed, in ISO 8601 format.
-
replyDate(optional):
string(date)
When the last reply happened.
-
replyDateInISO8601Format(optional):
string
When the last reply happened, in ISO 8601 format.
-
replyURL(optional):
string(url)
A URL to any reply message.
-
socialObjectURL(optional):
string(url)
A URL to this object's containing collaboration object.
-
url(optional):
string(url)
A URL to this object.
Nested Schema : XV1FollowupType
Type:
Show Source
object
-
field(optional):
string
Allowed Values:
[ "FOR_YOUR_INFORMATION", "PLEASE_REPLY", "PLEASE_REPLY_URGENT" ]
V1 Followup Types.