Jump to

• Request
• Response

Get a list of folder IDs that have conversations associated with them.

get

/social/api/v1/hierarchicalMembers/{hierarchicalMemberID}

Request

Supported Media Types

• application/json

Path Parameters

• hierarchicalMemberID: integer(int64)
  The hierarchical member ID. The object's unique identifier from a long integer representation.

Body ()

Specify a filter to query.

Root Schema : XV1HierarchicalMembersFilterInfo

Type: object

V1 Hierarchical Members filter information.

Show Source

• folderID(optional): string
  The folder ID to search for.

{
    "description":"V1 Hierarchical Members filter information.",
    "properties":{
        "folderID":{
            "description":"The folder ID to search for.",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : XV1FolderIDListInfo

Type: object

List of folder IDs.

Show Source

• hasMore(optional): boolean
  If true, there are more items to be returned.
• ids(optional): array ids
  List of folder IDs.
• 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":"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 : ids

Type: array

List of folder IDs.

Show Source

• Array of: string
  List of folder IDs.

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

Back to Top