Nomadesk API

Controller: Link Management: GetSharedWithMe

GetSharedWithMe

This API call accepts filtering, see paging and filtering page.

Authentication Methods


  1. With a username and password
Input Parameter Type Description
Token* String Security token

*Required

CURL EXAMPLE
curl -v 'https://example.com/ctrller/api.php?&FilterBy=&FilterValue=&Sort=&Offset=0&Limit=25&Task=GetSharedWithMe&Token=f73a38e6-5369-3f77-f869-e466fa2caace'
RESPONSE
<Response>
    <Status>1</Status>
    <Message>Success</Message>
    <TotalCount>5</TotalCount>
    <SharedLinks>
        <SharedLink>
            <FileLinkId>27ee97db-34a0-3f1c-cc38-986f3d8599cb</FileLinkId>
            <AccountId>8b44b4ab-379a-7146-9fcd-f10b0a48e6f3</AccountId>
            <WorkspaceId>f67d408b-bb0b-ceaf-eac9-d3943e683043</WorkspaceId>
            <FilePath>/path1</FilePath>            
            <Downloads>2</Downloads>
            <Sender>
                <Email>user1@example.com</Email>
                <FirstName>user</FirstName>
                <LastName>1</LastName>
            </Sender>
            <LinkId>003f4549-8c49-5b66-678c-e287b31a5134</LinkId>
            <Active>true</Active>
            <AccessType>ReadOnly</AccessType>
            <LinkType>FolderLink</LinkType>
            <CreationDate>2018-08-01 15:45:41</CreationDate>
        </SharedLink>
        <SharedLink>
            <FileLinkId>869a0f83-12d1-e3ca-8f3c-61b347268a1b</FileLinkId>
            <AccountId>8b44b4ab-379a-7146-9fcd-f10b0a48e6f3</AccountId>
            <WorkspaceId>f67d408b-bb0b-ceaf-eac9-d3943e683043</WorkspaceId>
            <FilePath>/path2</FilePath>            
            <Downloads>7</Downloads>
                <Email>user2@example.com</Email>
                <FirstName>user</FirstName>
                <LastName>2</LastName>
            <LinkId>22465a14-932e-a9a0-302c-f2ba3f0deff1</LinkId>
            <Active>true</Active>
            <AccessType>ReadOnly</AccessType>
            <LinkType>FolderLink</LinkType>
            <CreationDate>2018-11-19 17:37:38</CreationDate>
        </SharedLink>
        <SharedLink>
            <FileLinkId>6d34be44-d12d-dfae-e500-74fcde43e428</FileLinkId>
            <AccountId>8b44b4ab-379a-7146-9fcd-f10b0a48e6f3</AccountId>
            <WorkspaceId>f67d408b-bb0b-ceaf-eac9-d3943e683043</WorkspaceId>
            <FilePath>/path3</FilePath>            
            <Downloads>4</Downloads>
                <Email>user3@example.com</Email>
                <FirstName>user</FirstName>
                <LastName>3</LastName>          
            <LinkId>1b766576-0a06-a6c2-821d-526444090053</LinkId>
            <Active>true</Active>
            <AccessType>ReadOnly</AccessType>
            <LinkType>FolderLink</LinkType>
            <CreationDate>2018-11-20 17:12:59</CreationDate>
        </SharedLink>
        <SharedLink>
            <FileLinkId>29f64d19-998d-7d59-005a-d3a7072a6569</FileLinkId>
            <AccountId>8b44b4ab-379a-7146-9fcd-f10b0a48e6f3</AccountId>
            <WorkspaceId>564d3db0-fb13-dec5-18a9-b1201489f35a</WorkspaceId>
            <FilePath>/test_file.txt</FilePath>            
            <Downloads>4</Downloads>
                <Email>user1@example.com</Email>
                <FirstName>user</FirstName>
                <LastName>1</LastName>              
            <LinkId>bff82ebc-26cc-66ea-2337-1d25b60a5f97</LinkId>
            <Active>true</Active>
            <AccessType>ReadOnly</AccessType>
            <LinkType>FolderLink</LinkType>
            <CreationDate>2018-11-21 10:58:40</CreationDate>
        </SharedLink>
        <SharedLink>
            <FileLinkId>3946803d-f084-794f-37d4-052d96c022e2</FileLinkId>
            <AccountId>8b44b4ab-379a-7146-9fcd-f10b0a48e6f3</AccountId>
            <WorkspaceId>564d3db0-fb13-dec5-18a9-b1201489f35a</WorkspaceId>
            <FilePath>/path4</FilePath>            
            <Downloads>3</Downloads>
            <Sender>
                <Email>user1@example.com</Email>
                <FirstName>user</FirstName>
                <LastName>1</LastName>
            </Sender>
            <LinkId>593316e7-4d80-2325-39d4-b4689f90fb59</LinkId>
            <Active>true</Active>
            <AccessType>ReadOnly</AccessType>
            <LinkType>FolderLink</LinkType>
            <CreationDate>2018-11-21 10:59:46</CreationDate>
        </SharedLink>
    </SharedLinks>
</Response>
CURL EXAMPLE with filtering
    curl -v 'https://example.com/ctrller/api.php?&FilterBy[]=sender&FilterValue[]=user1&Sort=&Offset=0&Limit=25&Task=GetSharedWithMe&Token=f73a38e6-5369-3f77-f869-e466fa2caace'
RESPONSE
<Response>
    <Status>1</Status>
    <Message>Success</Message>
    <TotalCount>3</TotalCount>
    <SharedLinks>
        <SharedLink>
            <FileLinkId>27ee97db-34a0-3f1c-cc38-986f3d8599cb</FileLinkId>
            <AccountId>8b44b4ab-379a-7146-9fcd-f10b0a48e6f3</AccountId>
            <WorkspaceId>f67d408b-bb0b-ceaf-eac9-d3943e683043</WorkspaceId>
            <FilePath>/path1</FilePath>            
            <Downloads>2</Downloads>
            <Sender>
                <Email>user1@example.com</Email>
                <FirstName>user</FirstName>
                <LastName>1</LastName>
            </Sender>               
            <LinkId>003f4549-8c49-5b66-678c-e287b31a5134</LinkId>
            <Active>true</Active>
            <AccessType>ReadOnly</AccessType>
            <LinkType>FolderLink</LinkType>
            <CreationDate>2018-08-01 15:45:41</CreationDate>
        </SharedLink>
        <SharedLink>
            <FileLinkId>29f64d19-998d-7d59-005a-d3a7072a6569</FileLinkId>
            <AccountId>8b44b4ab-379a-7146-9fcd-f10b0a48e6f3</AccountId>
            <WorkspaceId>564d3db0-fb13-dec5-18a9-b1201489f35a</WorkspaceId>
            <FilePath>/test_file.txt</FilePath>            
            <Downloads>4</Downloads>
            <Sender>
                <Email>user1@example.com</Email>
                <FirstName>user</FirstName>
                <LastName>1</LastName>
            </Sender>               
            <LinkId>bff82ebc-26cc-66ea-2337-1d25b60a5f97</LinkId>
            <Active>true</Active>
            <AccessType>ReadOnly</AccessType>
            <LinkType>FolderLink</LinkType>
            <CreationDate>2018-11-21 10:58:40</CreationDate>
        </SharedLink>
        <SharedLink>
            <FileLinkId>3946803d-f084-794f-37d4-052d96c022e2</FileLinkId>
            <AccountId>8b44b4ab-379a-7146-9fcd-f10b0a48e6f3</AccountId>
            <WorkspaceId>564d3db0-fb13-dec5-18a9-b1201489f35a</WorkspaceId>
            <FilePath>/path4</FilePath>            
            <Downloads>3</Downloads>
            <Sender>
                <Email>user1@example.com</Email>
                <FirstName>user</FirstName>
                <LastName>1</LastName>
            </Sender>
            <LinkId>593316e7-4d80-2325-39d4-b4689f90fb59</LinkId>
            <Active>true</Active>
            <AccessType>ReadOnly</AccessType>
            <LinkType>FolderLink</LinkType>
            <CreationDate>2018-11-21 10:59:46</CreationDate>
        </SharedLink>
    </SharedLinks>
</Response>