Jump to

• Request
• Response
• Examples

Get a filtered list of all conversations.

get

/social/api/v1/conversations

Request

Supported Media Types

• application/json

Body ()

Specify a filter to query.

Root Schema : XV1ConversationFilterInfo

Type: object

V1 Conversation Filter Information.

Show Source

• commonMemberID:
  An object's unique identifier from a long integer representation.
• excludeClosed: boolean
  Set true to exclude closed conversations. If both excludeOpen and excludeClosed are specified as true, no conversations will ever be returned.
• excludeFullyRead: boolean
  Set true to exclude conversations with no unread messages.
• excludeMembered: boolean
  Set true to exclude conversations this user is a direct or indirect member of. If includeDiscoverable is specified as false and excludeMembered is specified as true, no conversations will ever be returned.
• excludeMuted: boolean
  Set true to exclude muted conversations. It does not make sense to set both excludeMuted and limitToMuted true.
• excludeOneOnOne: boolean
  Set true to exclude one-on-one conversations. It does not make sense to set both excludeOneOnOne and limitToOneOnOne true.
• excludeOpen: boolean
  Set true to exclude open conversations. If both excludeOpen and excludeClosed are specified as true, no conversations will ever be returned.
• excludeWalls: boolean
  Set true to exclude wall conversations. It does not make sense to set both excludeWalls and limitToWalls true.
• includeDisabled: boolean
  Used with LimitToUserWalls or LimitToGroupWalls to limit returned walls to those where the owning member (user or group) is either enabled or disabled. If neither or both of these booleans are specified, all of the selected walls will be returned.
• includeDiscoverable: boolean
  Set true to include Discoverable conversations. If includeDiscoverable is specified as false and excludeMembered is specified as true, no conversations will ever be returned.
• includeEnabled: boolean
  Used with LimitToUserWalls or LimitToGroupWalls to limit returned walls to those where the owning member (user or group) is either enabled or disabled. If neither or both of these booleans are specified, all of the selected walls will be returned.
• includeGadgetTrackables: boolean
  Specifies that if limitToGadgetID, limitToGadgetIDs or limitToGadgetGroup is specified, the directly related conversations should also be returned.
• limitToConferenceInProgress: boolean
  Limit to conversations with an active conference.
• limitToContainedConversations:
  An object's unique identifier from a long integer representation.
• limitToContainingConversations:
  An object's unique identifier from a long integer representation.
• limitToGadgetExternalID: string
  Limit to conversations with the specified type Gadget ExternalID. Should not be specified along with limitToGadgetID, limitToGadgetIDs or limitToGadgetGroup.
• limitToGadgetGroup: string
  Limit to conversations with the specified type Gadget Group. Should not be specified along with limitToGadgetID, limitToGadgetIDs or limitToGadgetExternalID.
• limitToGadgetID:
  An object's unique identifier from a long integer representation.
• limitToGadgetIDs: array limitToGadgetIDs
  Limit to conversations with the specified type Gadget IDs. Should not be specified along with limitToGadgetID, limitToGadgetGroup or limitToGadgetExternalID.
• limitToGroupWalls: boolean
  Limit results to group wall conversations. It does not make sense to set both limitToGroupWalls and limitToUserWalls or limitToGroupWalls and limitToOneOnOne to true.
• limitToLiked: boolean
  Limit to conversations the current user has liked.
• limitToMuted: boolean
  Set true to limit to muted conversations. It does not make sense to set both excludeMuted and limitToMuted true.
• limitToNLikes: integer(int32)
  Limit to conversations that have been liked by n or more users.

  If null is specified, then no check is performed; otherwise, the conversation must have been liked by at least the specified number of users.

• limitToNStars: integer(int32)
  Limit to conversations that have been starred by n or more users.

  If null is specified, then no check is performed; otherwise the conversation must have been starred by at least the specified number of users.

• limitToOneOnOne: boolean
  Limit results to one-on-one conversations. It does not make sense to set both limitToOneOnOne and limitToUserWalls or limitToOneOnOne and limitToGroupWalls to true.
• limitToRating: integer(int32)
  Deprecated, to be removed in v2.
• limitToRatings: integer(int32)
  Deprecated, to be removed in v2.
• limitToSortGTZero: boolean
  When sortField is specified as any of the following, this boolean, if true, will limit the result to only conversations where the sorting value is greater than zero (0).

    	CONVERSATION_IS_NEW  	CONVERSATION_N_MESSAGES  	CONVERSATION_N_MESSAGES_UNREAD  	CONVERSATION_N_ENTERED  	CONVERSATION_N_FOLLOWUPS  	CONVERSATION_ACTIVITY  	CONVERSATION_CONFERENCES  

• limitToSortSince: string(date)
  When SortField is specified as any of the following, this date, if specified, will limit the result to only conversations where the sorting value is later (more recent).

    		CONVERSATION_CREATED_DATE  		CONVERSATION_LAST_POST  

• limitToStarred: boolean
  Limit to conversations the current user has starred.
• limitToUserWalls: boolean
  Limit results to user wall conversations. It does not make sense to set both limitToUserWalls and limitToGroupWalls or limitToUserWalls and limitToOneOnOne to true.
• limitToWalls: boolean
  Set true to include only wall conversations. It does not make sense to set both excludeWalls and limitToWalls true.
• sortField: object XV1ConversationSortField
• sortOrderDescending: boolean
  Sort is descending.

{
    "description":"V1 Conversation Filter Information.",
    "properties":{
        "commonMemberID":{
            "$ref":"#/definitions/XObjectID"
        },
        "excludeClosed":{
            "description":"Set true to exclude closed conversations. If both excludeOpen and  excludeClosed are specified as true, no conversations will ever be returned.",
            "type":"boolean"
        },
        "excludeFullyRead":{
            "description":"Set true to exclude conversations with no unread messages.",
            "type":"boolean"
        },
        "excludeMembered":{
            "description":"Set true to exclude conversations this user is a direct or indirect member of. If  includeDiscoverable is specified as false and excludeMembered is specified as true, no conversations  will ever be returned.",
            "type":"boolean"
        },
        "excludeMuted":{
            "description":"Set true to exclude muted conversations. It does not make sense to  set both excludeMuted and limitToMuted true.",
            "type":"boolean"
        },
        "excludeOneOnOne":{
            "description":"Set true to exclude one-on-one conversations. It does not make sense to  set both excludeOneOnOne and limitToOneOnOne true.",
            "type":"boolean"
        },
        "excludeOpen":{
            "description":"Set true to exclude open conversations. If both excludeOpen and  excludeClosed are specified as true, no conversations will ever be returned.",
            "type":"boolean"
        },
        "excludeWalls":{
            "description":"Set true to exclude wall conversations. It does not make sense to  set both excludeWalls and limitToWalls true.",
            "type":"boolean"
        },
        "includeDisabled":{
            "description":"Used with LimitToUserWalls or LimitToGroupWalls to limit returned walls to those  where the owning member (user or group) is either enabled or disabled. If neither or  both of these booleans are specified, all of the selected walls will be returned.",
            "type":"boolean"
        },
        "includeDiscoverable":{
            "description":"Set true to include Discoverable conversations. If includeDiscoverable is specified  as false and excludeMembered is specified as true, no conversations will ever be returned.",
            "type":"boolean"
        },
        "includeEnabled":{
            "description":"Used with LimitToUserWalls or LimitToGroupWalls to limit returned walls to those  where the owning member (user or group) is either enabled or disabled. If neither or  both of these booleans are specified, all of the selected walls will be returned.",
            "type":"boolean"
        },
        "includeGadgetTrackables":{
            "description":"Specifies that if limitToGadgetID, limitToGadgetIDs or limitToGadgetGroup is  specified, the directly related conversations should also be returned.",
            "type":"boolean"
        },
        "limitToConferenceInProgress":{
            "description":"Limit to conversations with an active conference.",
            "type":"boolean"
        },
        "limitToContainedConversations":{
            "$ref":"#/definitions/XObjectID"
        },
        "limitToContainingConversations":{
            "$ref":"#/definitions/XObjectID"
        },
        "limitToGadgetExternalID":{
            "description":"Limit to conversations with the specified type Gadget ExternalID. Should not  be specified along with limitToGadgetID, limitToGadgetIDs or limitToGadgetGroup.",
            "type":"string"
        },
        "limitToGadgetGroup":{
            "description":"Limit to conversations with the specified type Gadget Group. Should not  be specified along with limitToGadgetID, limitToGadgetIDs or limitToGadgetExternalID.",
            "type":"string"
        },
        "limitToGadgetID":{
            "$ref":"#/definitions/XObjectID"
        },
        "limitToGadgetIDs":{
            "description":"Limit to conversations with the specified type Gadget IDs. Should not  be specified along with limitToGadgetID, limitToGadgetGroup or limitToGadgetExternalID.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/XObjectID"
            }
        },
        "limitToGroupWalls":{
            "description":"Limit results to group wall conversations. It does not make sense  to set both limitToGroupWalls and limitToUserWalls or limitToGroupWalls and limitToOneOnOne to true.",
            "type":"boolean"
        },
        "limitToLiked":{
            "description":"Limit to conversations the current user has liked.",
            "type":"boolean"
        },
        "limitToMuted":{
            "description":"Set true to limit to muted conversations. It does not make sense to  set both excludeMuted and limitToMuted true.",
            "type":"boolean"
        },
        "limitToNLikes":{
            "description":"Limit to conversations that have been liked by n or more users.  <p/>  If null is specified, then no check is performed; otherwise, the conversation  must have been liked by at least the specified number of users.",
            "type":"integer",
            "format":"int32"
        },
        "limitToNStars":{
            "description":"Limit to conversations that have been starred by n or more users.  <p/>  If null is specified, then no check is performed; otherwise the conversation  must have been starred by at least the specified number of users.",
            "type":"integer",
            "format":"int32"
        },
        "limitToOneOnOne":{
            "description":"Limit results to one-on-one conversations. It does not make sense  to set both limitToOneOnOne and limitToUserWalls or limitToOneOnOne and limitToGroupWalls to true.",
            "type":"boolean"
        },
        "limitToRating":{
            "description":"Deprecated, to be removed in v2.",
            "type":"integer",
            "format":"int32"
        },
        "limitToRatings":{
            "description":"Deprecated, to be removed in v2.",
            "type":"integer",
            "format":"int32"
        },
        "limitToSortGTZero":{
            "description":"When sortField is specified as any of the following, this boolean, if true, will limit the result to only conversations where the sorting value is greater than zero (0).   <pre>  \tCONVERSATION_IS_NEW  \tCONVERSATION_N_MESSAGES  \tCONVERSATION_N_MESSAGES_UNREAD  \tCONVERSATION_N_ENTERED  \tCONVERSATION_N_FOLLOWUPS  \tCONVERSATION_ACTIVITY  \tCONVERSATION_CONFERENCES  </pre>",
            "type":"boolean"
        },
        "limitToSortSince":{
            "description":"When SortField is specified as any of the following, this date, if specified, will limit the result to only conversations where the sorting value is later (more recent).  <pre>  \t\tCONVERSATION_CREATED_DATE  \t\tCONVERSATION_LAST_POST  </pre>",
            "type":"string",
            "format":"date"
        },
        "limitToStarred":{
            "description":"Limit to conversations the current user has starred.",
            "type":"boolean"
        },
        "limitToUserWalls":{
            "description":"Limit results to user wall conversations. It does not make sense  to set both limitToUserWalls and limitToGroupWalls or limitToUserWalls and limitToOneOnOne to true.",
            "type":"boolean"
        },
        "limitToWalls":{
            "description":"Set true to include only wall conversations. It does not make sense  to set both excludeWalls and limitToWalls true.",
            "type":"boolean"
        },
        "sortField":{
            "$ref":"#/definitions/XV1ConversationSortField"
        },
        "sortOrderDescending":{
            "description":"Sort is descending.",
            "type":"boolean"
        }
    }
}

Nested Schema : limitToGadgetIDs

Type: array

Limit to conversations with the specified type Gadget IDs. Should not be specified along with limitToGadgetID, limitToGadgetGroup or limitToGadgetExternalID.

Show Source

• [0]:
  An object's unique identifier from a long integer representation.

{
    "description":"Limit to conversations with the specified type Gadget IDs. Should not  be specified along with limitToGadgetID, limitToGadgetGroup or limitToGadgetExternalID.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/XObjectID"
    }
}

Nested Schema : XV1ConversationSortField

Type: object

Show Source

• field: string
  Allowed Values: [ "CONVERSATION_ACTIVITY", "CONVERSATION_CONFERENCES", "CONVERSATION_CREATED_DATE", "CONVERSATION_IS_NEW", "CONVERSATION_LAST_POST", "CONVERSATION_N_ENTERED", "CONVERSATION_N_FOLLOWUPS", "CONVERSATION_N_MESSAGES", "CONVERSATION_N_MESSAGES_UNREAD", "CONVERSATION_NAME", "CONVERSATION_STATE", "CONVERSATION_TYPE" ]

  V1 Conversation Sort Fields.

{
    "properties":{
        "field":{
            "type":"string",
            "description":"V1 Conversation Sort Fields.",
            "enum":[
                "CONVERSATION_ACTIVITY",
                "CONVERSATION_CONFERENCES",
                "CONVERSATION_CREATED_DATE",
                "CONVERSATION_IS_NEW",
                "CONVERSATION_LAST_POST",
                "CONVERSATION_N_ENTERED",
                "CONVERSATION_N_FOLLOWUPS",
                "CONVERSATION_N_MESSAGES",
                "CONVERSATION_N_MESSAGES_UNREAD",
                "CONVERSATION_NAME",
                "CONVERSATION_STATE",
                "CONVERSATION_TYPE"
            ]
        }
    }
}

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

V1 Conversation List Information DTO.

Root Schema : XV1ConversationListInfo

Type: object

V1 Conversation List Information DTO.

Show Source

• hasMore: boolean
  If true, there are more items to be returned.
• items: array items
  The conversations being returned.
• nextURL: string(url)
  Next page URL for the list. Null if this is the last page.
• previousURL: string(url)
  Previous page URL for the list. Null if this is the first page.
• total: integer(int32)
  If specified, this is the total number of available items. Null if the total is unknown.

{
    "description":"V1 Conversation List Information DTO.",
    "properties":{
        "items":{
            "description":"The conversations being returned.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/XV1ConversationInfo"
            }
        },
        "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 conversations being returned.

Show Source

• [0]: object XV1ConversationInfo
  V1 Conversation Information DTO.

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

Nested Schema : XV1ConversationInfo

Type: object

V1 Conversation Information DTO.

Show Source

• allMembershipsURL: string(url)
  A URL to the hierarchical memberships of this conversation.
• altitude: number(double)
  The object's altitude.
• archiveURL: string(url)
  A URL to the archive of this conversation.
• collectionURL: string(url)
  A URL to this object's containing collection.
• conversationURL: string(url)
  A URL to this object's containing conversation.
• createdByID:
  An object's unique identifier from a long integer representation.
• createdByURL: string(url)
  A URL to the user that created this object.
• createdByUserDisplayName: string
  The display name of the user that created this object.
• createdByUserName: string
  The name of the user that created this object.
• createdDate: string(date)
  The date this object was created.
• createdDateInISO8601Format: string
  The date this object was created, in ISO 8601 format.
• dateFormatLocale: string(locale)
  The locale of the appropriate date format for this conversation.
• discoverableID:
  An object's unique identifier from a long integer representation.
• displayName: string
  The display name of this object.
• externalID: string
  The primary external ID of this conversation.
• folderID:
  An object's unique identifier from a long integer representation.
• folderURL: string(url)
  A URL to the root folder of this conversation.
• gadgetsURL: string(url)
  A URL to the gadgets of this conversation.
• hasMembersLocked: boolean
  True if the membership of this conversation is locked.
• hierarchicalMembersInfo: object XV1HierarchicalMembersInfo
  V1 Hierarchical Members Information DTO.
• id:
  An object's unique identifier from a long integer representation.
• isDisallowGuests: boolean
  True if this conversation does not allow guest users.
• isDisallowOutsiders: boolean
  True if this conversation does not allow outsider users.
• isDiscoverable: boolean
  True if this conversation is discoverable (public).
• isExtendedAccessControl: boolean
  True if this conversation uses extended access control.
• isMuted: boolean
  True if this conversation is muted for the current user.
• isNew: boolean
  True if this conversation has not been entered by the current user.
• isRemoved: boolean
  True if this message has been removed.
• isScoped: boolean
  True if the membership of this conversation is scoped by another conversation.
• isScoping: boolean
  True if this is a scoping conversation.
• isScopingSame: boolean
  True if this conversation is scoped to have the same membership as another conversation.
• languageLocale: string(locale)
  The language locale for this conversation.
• latitude: number(double)
  The object's latitude.
• likesURL: string(url)
  A URL to the likes of this conversation.
• longitude: number(double)
  The object's longitude.
• membershipsURL: string(url)
  A URL to the memberships of this conversation.
• membersURL: string(url)
  A URL to the members of this conversation.
• messagesURL: string(url)
  A URL to the messages in this conversation.
• modifiedByID:
  An object's unique identifier from a long integer representation.
• modifiedByURL: string(url)
  A URL to the user that last modified this object.
• modifiedByUserDisplayName: string
  The display name of the user that last modified this object.
• modifiedByUserName: string
  The name of the user that last modified this object.
• modifiedDate: string(date)
  The date this object was last modified.
• modifiedDateInISO8601Format: string
  The date this object was last modified, in ISO 8601 format.
• name: string
  The name of this object.
• nChats: integer(int32)
  The number of chats in this conversation. (total chats less deleted chats.)
• nFollowups: integer(int32)
  The number of followups in the conversation.
• nMarkableChats: integer(int32)
  The number of chats that could be marked read. (Total markable less deleted markable. Does not depend on the current user.)
• nOutsiders: integer(int32)
  Count of the outside users.
• nUnread: integer(int32)
  The number of chats that the current user can mark read.
• objectType: string
  The type of this object.
• originalPictureURL: string(url)
  The original picture URL.
• profilePictureURL: string(url)
  The profile picture URL (150 px by 150 px).
• propertiesURL: string(url)
  A URL to the properties of this conversation.
• removedByID:
  An object's unique identifier from a long integer representation.
• removedByURL: string(url)
  A URL to the user that last removed this object.
• removedByUserDisplayName: string
  The display name of the user that last removed this object.
• removedByUserName: string
  The name of the user that last removed this object.
• removedDate: string(date)
  The date this object was removed.
• removedDateInISO8601Format: string
  The date this object was removed, in ISO 8601 format.
• role: string
  The current user's role in this conversation.
• scaledPictureURL: string(url)
  The scaled picture URL (44 px by 44 px).
• secondaryExternalIDs: array secondaryExternalIDs
  The secondary external IDs for this conversation.
• securityContextID: string
  The ID of the service that dictates the security for this Conversation object.
• socialObjectURL: string(url)
  A URL to this object's containing collaboration object.
• starsURL: string(url)
  A URL to the stars of this conversation.
• state: object XV1ConversationState
• timeZone: string(timezone)
  The time zone for this conversation.
• url: string(url)
  A URL to this object.
• userPropertiesURL: string(url)
  A URL to the user properties of this conversation.
• wallPostControl: object XV1WallPostControlEnum

{
    "description":"V1 Conversation Information DTO.",
    "properties":{
        "allMembershipsURL":{
            "description":"A URL to the hierarchical memberships of this conversation.",
            "type":"string",
            "format":"url"
        },
        "archiveURL":{
            "description":"A URL to the archive of this conversation.",
            "type":"string",
            "format":"url"
        },
        "dateFormatLocale":{
            "description":"The locale of the appropriate date format for this conversation.",
            "type":"string",
            "format":"locale"
        },
        "discoverableID":{
            "$ref":"#/definitions/XObjectID"
        },
        "externalID":{
            "description":"The primary external ID of this conversation.",
            "type":"string"
        },
        "folderID":{
            "$ref":"#/definitions/XObjectID"
        },
        "folderURL":{
            "description":"A URL to the root folder of this conversation.",
            "type":"string",
            "format":"url"
        },
        "gadgetsURL":{
            "description":"A URL to the gadgets of this conversation.",
            "type":"string",
            "format":"url"
        },
        "hasMembersLocked":{
            "description":"True if the membership of this conversation is locked.",
            "type":"boolean"
        },
        "hierarchicalMembersInfo":{
            "$ref":"#/definitions/XV1HierarchicalMembersInfo"
        },
        "isDisallowGuests":{
            "description":"True if this conversation does not allow guest users.",
            "type":"boolean"
        },
        "isDisallowOutsiders":{
            "description":"True if this conversation does not allow outsider users.",
            "type":"boolean"
        },
        "isDiscoverable":{
            "description":"True if this conversation is discoverable (public).",
            "type":"boolean"
        },
        "isExtendedAccessControl":{
            "description":"True if this conversation uses extended access control.",
            "type":"boolean"
        },
        "isMuted":{
            "description":"True if this conversation is muted for the current user.",
            "type":"boolean"
        },
        "isNew":{
            "description":"True if this conversation has not been entered by the current user.",
            "type":"boolean"
        },
        "isScoped":{
            "description":"True if the membership of this conversation is scoped by another conversation.",
            "type":"boolean"
        },
        "isScoping":{
            "description":"True if this is a scoping conversation.",
            "type":"boolean"
        },
        "isScopingSame":{
            "description":"True if this conversation is scoped to have the same membership as another conversation.",
            "type":"boolean"
        },
        "languageLocale":{
            "description":"The language locale for this conversation.",
            "type":"string",
            "format":"locale"
        },
        "likesURL":{
            "description":"A URL to the likes of this conversation.",
            "type":"string",
            "format":"url"
        },
        "membershipsURL":{
            "description":"A URL to the memberships of this conversation.",
            "type":"string",
            "format":"url"
        },
        "membersURL":{
            "description":"A URL to the members of this conversation.",
            "type":"string",
            "format":"url"
        },
        "messagesURL":{
            "description":"A URL to the messages in this conversation.",
            "type":"string",
            "format":"url"
        },
        "nChats":{
            "description":"The number of chats in this conversation. (total chats less deleted chats.)",
            "type":"integer",
            "format":"int32"
        },
        "nFollowups":{
            "description":"The number of followups in the conversation.",
            "type":"integer",
            "format":"int32"
        },
        "nMarkableChats":{
            "description":"The number of chats that could be marked read. (Total markable less deleted markable. Does not depend on the current user.)",
            "type":"integer",
            "format":"int32"
        },
        "nOutsiders":{
            "description":"Count of the outside users.",
            "type":"integer",
            "format":"int32"
        },
        "nUnread":{
            "description":"The number of chats that the current user can mark read.",
            "type":"integer",
            "format":"int32"
        },
        "propertiesURL":{
            "description":"A URL to the properties of this conversation.",
            "type":"string",
            "format":"url"
        },
        "role":{
            "description":"The current user's role in this conversation.",
            "type":"string"
        },
        "secondaryExternalIDs":{
            "description":"The secondary external IDs for this conversation.",
            "type":"array",
            "items":{
                "description":"The secondary external IDs for this conversation.",
                "type":"string"
            }
        },
        "securityContextID":{
            "description":"The ID of the service that dictates the security for this Conversation object.",
            "type":"string"
        },
        "starsURL":{
            "description":"A URL to the stars of this conversation.",
            "type":"string",
            "format":"url"
        },
        "state":{
            "$ref":"#/definitions/XV1ConversationState"
        },
        "timeZone":{
            "description":"The time zone for this conversation.",
            "type":"string",
            "format":"timezone"
        },
        "userPropertiesURL":{
            "description":"A URL to the user properties of this conversation.",
            "type":"string",
            "format":"url"
        },
        "wallPostControl":{
            "$ref":"#/definitions/XV1WallPostControlEnum"
        },
        "originalPictureURL":{
            "description":"The original picture URL.",
            "type":"string",
            "format":"url"
        },
        "profilePictureURL":{
            "description":"The profile picture URL (150 px by 150 px).",
            "type":"string",
            "format":"url"
        },
        "scaledPictureURL":{
            "description":"The scaled picture URL (44 px by 44 px).",
            "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 : XV1HierarchicalMembersInfo

Type: object

V1 Hierarchical Members Information DTO.

Show Source

• createdFolderIDs: object XV1FolderIDListInfo
  List of folder IDs.
• ignoredMembers: object XV1IgnoredMemberListInfo
  List of ignored members.
• ignoredUsers: object XV1IgnoredUserListInfo
  List of ignored users.
• operationType: object XV1HierarchicalMembersOperationType
• removedFolderIDs: object XV1FolderIDListInfo
  List of folder IDs.

{
    "description":"V1 Hierarchical Members Information DTO.",
    "properties":{
        "createdFolderIDs":{
            "$ref":"#/definitions/XV1FolderIDListInfo"
        },
        "ignoredMembers":{
            "$ref":"#/definitions/XV1IgnoredMemberListInfo"
        },
        "ignoredUsers":{
            "$ref":"#/definitions/XV1IgnoredUserListInfo"
        },
        "operationType":{
            "$ref":"#/definitions/XV1HierarchicalMembersOperationType"
        },
        "removedFolderIDs":{
            "$ref":"#/definitions/XV1FolderIDListInfo"
        }
    }
}

Nested Schema : secondaryExternalIDs

Type: array

The secondary external IDs for this conversation.

Show Source

• [0]: string
  The secondary external IDs for this conversation.

{
    "description":"The secondary external IDs for this conversation.",
    "type":"array",
    "items":{
        "description":"The secondary external IDs for this conversation.",
        "type":"string"
    }
}

Nested Schema : XV1ConversationState

Type: object

Show Source

• field: string
  Allowed Values: [ "CLOSED_CHAINED", "CLOSED_DISABLED", "CLOSED_DROPPED", "CLOSED_RESOLVED", "OPEN_ACTIVE" ]

  V1 Conversation States.

{
    "properties":{
        "field":{
            "type":"string",
            "description":"V1 Conversation States.",
            "enum":[
                "CLOSED_CHAINED",
                "CLOSED_DISABLED",
                "CLOSED_DROPPED",
                "CLOSED_RESOLVED",
                "OPEN_ACTIVE"
            ]
        }
    }
}

Nested Schema : XV1WallPostControlEnum

Type: object

Show Source

• field: string
  Allowed Values: [ "ANYONE_CAN_POST", "OWNER_ONLY_POSTS", "OWNER_TOP_LEVEL" ]

  V1 Wall Posting Control Enum.

{
    "properties":{
        "field":{
            "type":"string",
            "description":"V1 Wall Posting Control Enum.",
            "enum":[
                "ANYONE_CAN_POST",
                "OWNER_ONLY_POSTS",
                "OWNER_TOP_LEVEL"
            ]
        }
    }
}

Nested Schema : XV1FolderIDListInfo

Type: object

List of folder IDs.

Show Source

• hasMore: boolean
  If true, there are more items to be returned.
• ids: array ids
  List of folder IDs.
• nextURL: string(url)
  Next page URL for the list. Null if this is the last page.
• previousURL: string(url)
  Previous page URL for the list. Null if this is the first page.
• total: integer(int32)
  If specified, this is the total number of available items. Null if the total is unknown.

{
    "description":"List of folder IDs.",
    "properties":{
        "ids":{
            "description":"List of folder IDs.",
            "type":"array",
            "items":{
                "description":"List of folder IDs.",
                "type":"string"
            }
        },
        "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 : XV1IgnoredMemberListInfo

Type: object

List of ignored members.

Show Source

• groups: array groups
  List of users.
• hasMore: boolean
  If true, there are more items to be returned.
• nextURL: string(url)
  Next page URL for the list. Null if this is the last page.
• previousURL: string(url)
  Previous page URL for the list. Null if this is the first page.
• total: integer(int32)
  If specified, this is the total number of available items. Null if the total is unknown.
• users: array users
  List of users.

{
    "description":"List of ignored members.",
    "properties":{
        "groups":{
            "description":"List of users.",
            "type":"array",
            "items":{
                "description":"List of users.",
                "type":"string"
            }
        },
        "users":{
            "description":"List of users.",
            "type":"array",
            "items":{
                "description":"List of users.",
                "type":"string"
            }
        },
        "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 : XV1IgnoredUserListInfo

Type: object

List of ignored users.

Show Source

• hasMore: boolean
  If true, there are more items to be returned.
• nextURL: string(url)
  Next page URL for the list. Null if this is the last page.
• previousURL: string(url)
  Previous page URL for the list. Null if this is the first page.
• total: integer(int32)
  If specified, this is the total number of available items. Null if the total is unknown.
• users: array users
  List of users.

{
    "description":"List of ignored users.",
    "properties":{
        "users":{
            "description":"List of users.",
            "type":"array",
            "items":{
                "description":"List of users.",
                "type":"string"
            }
        },
        "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 : XV1HierarchicalMembersOperationType

Type: object

Show Source

• field: string
  Allowed Values: [ "ASSOCIATE_CONVERSATION", "CREATE_CONVERSATION", "MOVE_FILE", "MOVE_FOLDER", "MOVE_MEMBERS", "REMOVE_MEMBERS", "REMOVE_MEMBERS_OBJECT", "SHARE_FOLDER" ]

  V1 Collaboration API Operation Types on Hierarchical Members.

{
    "properties":{
        "field":{
            "type":"string",
            "description":"V1 Collaboration API Operation Types on Hierarchical Members.",
            "enum":[
                "ASSOCIATE_CONVERSATION",
                "CREATE_CONVERSATION",
                "MOVE_FILE",
                "MOVE_FOLDER",
                "MOVE_MEMBERS",
                "REMOVE_MEMBERS",
                "REMOVE_MEMBERS_OBJECT",
                "SHARE_FOLDER"
            ]
        }
    }
}

Nested Schema : ids

Type: array

List of folder IDs.

Show Source

• [0]: string
  List of folder IDs.

{
    "description":"List of folder IDs.",
    "type":"array",
    "items":{
        "description":"List of folder IDs.",
        "type":"string"
    }
}

Nested Schema : groups

Type: array

List of users.

Show Source

• [0]: string
  List of users.

{
    "description":"List of users.",
    "type":"array",
    "items":{
        "description":"List of users.",
        "type":"string"
    }
}

Nested Schema : users

Type: array

List of users.

Show Source

• [0]: string
  List of users.

{
    "description":"List of users.",
    "type":"array",
    "items":{
        "description":"List of users.",
        "type":"string"
    }
}

Nested Schema : users

Type: array

List of users.

Show Source

• [0]: string
  List of users.

{
    "description":"List of users.",
    "type":"array",
    "items":{
        "description":"List of users.",
        "type":"string"
    }
}

Examples

The following example shows how to get a filtered list of all conversations by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X GET -c mycookies.jar -b mycookies.jar -H 'X-Waggle-RandomID:22a8a2ca707602ae2da3512e0ca28a06' -H 'Content-Type: application/json'  https://socialnetwork06065-ustraveler15926.socialnetwork.dc1.c9dev1.example.com/osn/social/api/v1/conversations

The following example includes a query filter parameter.

curl -X GET -c mycookies.jar -b mycookies.jar -H 'X-Waggle-RandomID:22a8a2ca707602ae2da3512e0ca28a06' -H 'Content-Type: application/json' 'https://socialnetwork06065-ustraveler1592.socialnetwork.dc1.c9dev1.example.com/osn/social/api/v1/conversations?filter={"excludeClosed":true,"excludeFullyRead":true}'

Example of Response Body

The following shows an example of the response JSON document.

{
  "hasMore" : false,
  "items" : 
  [
   {
    "id": "45029",
    "name": "text",
    "objectType": "waggle/conversation",
    "createdByID": "24114",
    "createdByUserName": "[e-mail]",
    "createdByUserDisplayName": "Rosanna Channing",
    "createdDate": "Thu, 03 Sep 2015 14:39:22 GMT",
    "modifiedByID": "24114",
    "modifiedByUserName": "[e-mail]",
    "modifiedByUserDisplayName": "Rosanna Channing",
    "modifiedDate": "Thu, 03 Sep 2015 14:39:22 GMT",
    "isRemoved": "false",
    "latitude": "11",
    "longitude": "11",
    "altitude": "1",
    "externalID": "text",
    "secondaryExternalIDs":
    ["a text",    ]
    "isScoping": "false",
    "isScopingSame": "false",
    "isScoped": "false",
    "state": "OPEN_ACTIVE",
    "isDiscoverable": "false",
    "wallPostControl": "ANYONE_CAN_POST",
    "hasMembersLocked": "false",
    "isDisallowGuests": "false",
    "isDisallowOutsiders": "false",
    "nOutsiders": "0",
    "isExtendedAccessControl": "false",
    "folderID": "45034",
    "role": "HOST",
    "isMuted": "false",
    "isNew": "false",
    "nChats": "7",
    "nMarkableChats": "5",
    "nUnread": "0",
    "nFollowups": "0",
   },
   {
    "id": "689280",
    "name": "A Warm Welcome to the Team",
    "objectType": "waggle/conversation",
    "createdByID": "24114",
    "createdByUserName": "[e-mail]",
    "createdByUserDisplayName": "Rosanna Channing",
    "createdDate": "Thu, 22 Oct 2015 22:40:49 GMT",
    "modifiedByID": "24114",
    "modifiedByUserName": "[e-mail]",
    "modifiedByUserDisplayName": "Rosanna Channing",
    "modifiedDate": "Thu, 22 Oct 2015 22:40:49 GMT",
    "isRemoved": "false",
    "secondaryExternalIDs":
    "isScoping": "false",
    "isScopingSame": "false",
    "isScoped": "false",
    "state": "OPEN_ACTIVE",
    "isDiscoverable": "true",
    "wallPostControl": "ANYONE_CAN_POST",
    "hasMembersLocked": "false",
    "isDisallowGuests": "false",
    "isDisallowOutsiders": "false",
    "nOutsiders": "0",
    "isExtendedAccessControl": "false",
    "folderID": "689285",
    "role": "HOST",
    "isMuted": "false",
    "isNew": "false",
    "nChats": "8",
    "nMarkableChats": "5",
    "nUnread": "1",
    "nFollowups": "0",
   }
  ] 
}