Jump to

• Request
• Response

Get a filtered list of all followups.

get

/social/api/v1/followups

Request

Supported Media Types

• application/json

Body ()

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.

{
    "description":"V1 Followup Filter Information DTO.",
    "properties":{
        "excludeSelfAssigned":{
            "description":"Exclude followups where the target user is both the assigner and assignee.",
            "type":"boolean"
        },
        "includeAssignee":{
            "description":"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.",
            "type":"boolean"
        },
        "includeAssignees":{
            "description":"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.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/XObjectID"
            }
        },
        "includeAssigner":{
            "description":"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.",
            "type":"boolean"
        },
        "includeAssigners":{
            "description":"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.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/XObjectID"
            }
        },
        "includeClosed":{
            "description":"Include closed followups.   The includeOpen or includeClosed field or both must be specified as true. Both false is  the same as includeOpen true.",
            "type":"boolean"
        },
        "includeNoReply":{
            "description":"Include no-reply followups.   The includeReply or includeNoReply field or both must be specified as true. Both false is the same as both true.",
            "type":"boolean"
        },
        "includeOpen":{
            "description":"Include open followups.   The includeOpen or includeClosed field or both must be specified as true. Both false  is the same as includeOpen true.",
            "type":"boolean"
        },
        "includeRead":{
            "description":"Include read followups.   The includeRead or includeUnread field or both must be specified as true. Both false is the same as both true.",
            "type":"boolean"
        },
        "includeReply":{
            "description":"Include reply followups.   The includeReply or includeNoReply field or both must be specified as true. Both false is the same as both true.",
            "type":"boolean"
        },
        "includeTypes":{
            "description":"Include specified followups types. If not specified, all types of followups are returned.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/XV1FollowupType"
            }
        },
        "includeUnread":{
            "description":"Include unread followups.   The includeRead or includeUnread field or both must be specified as true. Both false is the same as both true.",
            "type":"boolean"
        },
        "sortField":{
            "$ref":"#/definitions/XV1FollowupSortField"
        },
        "sortOrderDescending":{
            "description":"Sort is descending.",
            "type":"boolean"
        }
    }
}

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.

{
    "description":"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.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/XObjectID"
    }
}

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.

{
    "description":"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.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/XObjectID"
    }
}

Nested Schema : includeTypes

Type: array

Include specified followups types. If not specified, all types of followups are returned.

Show Source

• Array of: object XV1FollowupType

{
    "description":"Include specified followups types. If not specified, all types of followups are returned.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/XV1FollowupType"
    }
}

Nested Schema : XV1FollowupSortField

Type: object

Show Source

• field(optional): string
  Allowed Values: [ "FOLLOWUP_CHAT_DATE", "FOLLOWUP_CREATED_DATE", "FOLLOWUP_RECENT_ACTIVITY", "FOLLOWUP_TYPE" ]

  V1 Followup Sort Fields.

{
    "properties":{
        "field":{
            "type":"string",
            "description":"V1 Followup Sort Fields.",
            "enum":[
                "FOLLOWUP_CHAT_DATE",
                "FOLLOWUP_CREATED_DATE",
                "FOLLOWUP_RECENT_ACTIVITY",
                "FOLLOWUP_TYPE"
            ]
        }
    }
}

Nested Schema : XV1FollowupType

Type: object

Show Source

• field(optional): string
  Allowed Values: [ "FOR_YOUR_INFORMATION", "PLEASE_REPLY", "PLEASE_REPLY_URGENT" ]

  V1 Followup Types.

{
    "properties":{
        "field":{
            "type":"string",
            "description":"V1 Followup Types.",
            "enum":[
                "FOR_YOUR_INFORMATION",
                "PLEASE_REPLY",
                "PLEASE_REPLY_URGENT"
            ]
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

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.

{
    "description":"V1 Followup List Information DTO.",
    "properties":{
        "items":{
            "description":"The followups being returned.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/XV1FollowupInfo"
            }
        },
        "hasMore":{
            "description":"If true, there are more items to be returned.",
            "type":"boolean"
        },
        "nextURL":{
            "description":"Next page URL for the list. Null if this is the last page.",
            "type":"string",
            "format":"url"
        },
        "previousURL":{
            "description":"Previous page URL for the list. Null if this is the first page.",
            "type":"string",
            "format":"url"
        },
        "total":{
            "description":"If specified, this is the total number of available items. Null if the total is unknown.",
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : items

Type: array

The followups being returned.

Show Source

• Array of: object XV1FollowupInfo
  V1 Followup Information DTO.

{
    "description":"The followups being returned.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/XV1FollowupInfo"
    }
}

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.

{
    "description":"V1 Followup Information DTO.",
    "properties":{
        "assigneeDisplayName":{
            "description":"The display name of the user this followup is assigned to.",
            "type":"string"
        },
        "assigneeID":{
            "$ref":"#/definitions/XObjectID"
        },
        "assigneeName":{
            "description":"The name of the user this followup is assigned to.",
            "type":"string"
        },
        "assigneeURL":{
            "description":"A URL to the user this followup is assigned to.",
            "type":"string"
        },
        "assignerDisplayName":{
            "description":"The display name of the user who assigned this followup.",
            "type":"string"
        },
        "assignerID":{
            "$ref":"#/definitions/XObjectID"
        },
        "assignerName":{
            "description":"The name of the user who assigned this followup.",
            "type":"string"
        },
        "assignerURL":{
            "description":"A URL to the user who assigned this followup.",
            "type":"string",
            "format":"url"
        },
        "followupType":{
            "$ref":"#/definitions/XV1FollowupType"
        },
        "isOpen":{
            "description":"Whether this followup is open or closed.",
            "type":"boolean"
        },
        "isRead":{
            "description":"Whether this followup is read.",
            "type":"boolean"
        },
        "isReply":{
            "description":"Whether this followup has been replied to.",
            "type":"boolean"
        },
        "messageURL":{
            "description":"A URL to the message this followup is set on.",
            "type":"string",
            "format":"url"
        },
        "openDate":{
            "description":"When the open/close state last changed.",
            "type":"string",
            "format":"date"
        },
        "openDateInISO8601Format":{
            "description":"When the open/close state last changed, in ISO 8601 format.",
            "type":"string"
        },
        "openURL":{
            "description":"A URL to the user who last changed the open/close state.",
            "type":"string",
            "format":"url"
        },
        "readDate":{
            "description":"When the read state last changed.",
            "type":"string",
            "format":"date"
        },
        "readDateInISO8601Format":{
            "description":"When the read state last changed, in ISO 8601 format.",
            "type":"string"
        },
        "replyDate":{
            "description":"When the last reply happened.",
            "type":"string",
            "format":"date"
        },
        "replyDateInISO8601Format":{
            "description":"When the last reply happened, in ISO 8601 format.",
            "type":"string"
        },
        "replyURL":{
            "description":"A URL to any reply message.",
            "type":"string",
            "format":"url"
        },
        "altitude":{
            "description":"The object's altitude.",
            "type":"number",
            "format":"double"
        },
        "collectionURL":{
            "description":"A URL to this object's containing collection.",
            "type":"string",
            "format":"url"
        },
        "conversationURL":{
            "description":"A URL to this object's containing conversation.",
            "type":"string",
            "format":"url"
        },
        "createdByID":{
            "$ref":"#/definitions/XObjectID"
        },
        "createdByURL":{
            "description":"A URL to the user that created this object.",
            "type":"string",
            "format":"url"
        },
        "createdByUserDisplayName":{
            "description":"The display name of the user that created this object.",
            "type":"string"
        },
        "createdByUserName":{
            "description":"The name of the user that created this object.",
            "type":"string"
        },
        "createdDate":{
            "description":"The date this object was created.",
            "type":"string",
            "format":"date"
        },
        "createdDateInISO8601Format":{
            "description":"The date this object was created, in ISO 8601 format.",
            "type":"string"
        },
        "displayName":{
            "description":"The display name of this object.",
            "type":"string"
        },
        "id":{
            "$ref":"#/definitions/XObjectID"
        },
        "isRemoved":{
            "description":"True if this message has been removed.",
            "type":"boolean"
        },
        "latitude":{
            "description":"The object's latitude.",
            "type":"number",
            "format":"double"
        },
        "longitude":{
            "description":"The object's longitude.",
            "type":"number",
            "format":"double"
        },
        "modifiedByID":{
            "$ref":"#/definitions/XObjectID"
        },
        "modifiedByURL":{
            "description":"A URL to the user that last modified this object.",
            "type":"string",
            "format":"url"
        },
        "modifiedByUserDisplayName":{
            "description":"The display name of the user that last modified this object.",
            "type":"string"
        },
        "modifiedByUserName":{
            "description":"The name of the user that last modified this object.",
            "type":"string"
        },
        "modifiedDate":{
            "description":"The date this object was last modified.",
            "type":"string",
            "format":"date"
        },
        "modifiedDateInISO8601Format":{
            "description":"The date this object was last modified, in ISO 8601 format.",
            "type":"string"
        },
        "name":{
            "description":"The name of this object.",
            "type":"string"
        },
        "objectType":{
            "description":"The type of this object.",
            "type":"string"
        },
        "removedByID":{
            "$ref":"#/definitions/XObjectID"
        },
        "removedByURL":{
            "description":"A URL to the user that last removed this object.",
            "type":"string",
            "format":"url"
        },
        "removedByUserDisplayName":{
            "description":"The display name of the user that last removed this object.",
            "type":"string"
        },
        "removedByUserName":{
            "description":"The name of the user that last removed this object.",
            "type":"string"
        },
        "removedDate":{
            "description":"The date this object was removed.",
            "type":"string",
            "format":"date"
        },
        "removedDateInISO8601Format":{
            "description":"The date this object was removed, in ISO 8601 format.",
            "type":"string"
        },
        "socialObjectURL":{
            "description":"A URL to this object's containing collaboration object.",
            "type":"string",
            "format":"url"
        },
        "url":{
            "description":"A URL to this object.",
            "type":"string",
            "format":"url"
        }
    }
}

Nested Schema : XV1FollowupType

Type: object

Show Source

• field(optional): string
  Allowed Values: [ "FOR_YOUR_INFORMATION", "PLEASE_REPLY", "PLEASE_REPLY_URGENT" ]

  V1 Followup Types.

{
    "properties":{
        "field":{
            "type":"string",
            "description":"V1 Followup Types.",
            "enum":[
                "FOR_YOUR_INFORMATION",
                "PLEASE_REPLY",
                "PLEASE_REPLY_URGENT"
            ]
        }
    }
}

Back to Top