GET /users/{userId}/people/withdm

Find people that had prior direct space history with the viewer (Me).
The result of this api can include colleagues as well as people out-side of the viewer's company directory.

Note:

This api will also include all hidden direct conversations.
Read more on how to Hide Direct Spaces here.

Note: Use nextPageUrl and prevPageUrl from the response data for query pagination.

URL Parameters

NameDescriptionLocationRequiredDefault Value
userIdUnique identifier of the user whose colleagues to find. Use keyword me for current user.pathYes
searchRegular expression to filter colleague results. User properties searched: name, username, Uses "contain" string logic.
For "begin with" logic, use "^" sign, e.g.: "/withdm?search=^{query}"
For "end with" logic, use "$" sign, e.g.: "/withdm?search={query}$"		QueryNo
sizeThe number of responses to return per requestQueryNo10
pageThe page number of response dataQueryNo0

Body Parameters

None.

Authentication

JwtAuthenticator, Oauth2Authenticator, AnonymousAuthenticator

Authorization

OAuthAuthorizer

Example Request

URL

For Production: GET https://spacesapis.avayacloud.com/api/users/me/people/withdm?search=doe
For Staging: GET https://loganstagingapis.esna.com/api/users/me/people/withdm?search=doe

Headers

Authorization: "jwt eyJhbGciOiJSUzI1NiIsIdfgdfgnR5cCI6IkpXVCJ9.eyJ1c2VyX2lkX3NpZyI6ImxPWHpxNzVzR3J3X0xwWEMyRGRMakhyYXJlWVhyTzFMdEZHZkhkOWNkTXciLCJwcm9kdWN0X3R5cGUiOiJhY2NvdW50cyIsImxhc3R1cGRhdGV0aW1lIjoiMjAxNy0wMS0zMFQxMzo1ODo0Ny4yMDYiLCJpc3MiOiJ6YW5nLmlvIiwicHVibGlja2V5aWQiOiJhZ3h6Zm05dVpYTnVZVEl3TVRSeUdnc1NEVWRLZDNSUWRXSnNhV05MWlhrdfgdWdJQ2dsUEtFakFvTSIsImV4cCI6MTQ5NTM5MTIwMywidXNlcl9pZCI6ImFneHpmbTl1WlhOdVlUSXdNVFJ5RVFzU0JGVnpaWElZZ0lEQXMtX25fUW9NIiwidmVyIjoiMi4wIn0.SqZpw1uPIebqW3qlDsm0-DWYFKEH0SgPwtD-tSESWOF-5hLkZMqJH28ooWux2S7s9riIew7pTVPnZpTgJa5zHcEAG0gXSEJVOqmpGp_4ufM8YtZoZMpBFjyAkwyAt-ILkGUYIo0GU5WyzMPLV8YLXfgdfgOgkE2MGGOajBkjPmC2Db3pA0D0M9k-21EL1gwWBC5YIq0PDAkgulegwl6khRmB8irJQ-dfg-d-KV9eYfFpsCdJKRGzSfqg"

Or

Authorization: "bearer f746696f5de4528u128ae2f274eea253e8a7943a"

Example Response


{  
   "data":[  
      {  
         "_id":"fake_id1",
         "type":"user",
         "username":"alexd@abcd.com",
         "displayname":"Alex Doe",
         "picture_url":"fake_photo1.jpg",
         "phone_numbers":[  

         ]
      },
      {  
         "_id":"fake_id2",
         "type":"user",
         "username":"susan.doe@fakedomain.com",
         "displayname":"Susan Doe",
         "picture_url":"fake_photo1.jpg",
         "phone_numbers":[  

         ]
      }
   ],
   "nextPageUrl":"",
   "previousPageUrl":"",
   "total":2,
   "from":0,
   "to":1
}