Get info for a set of recipients
GET {{baseUrl}}/api/collaboration/recipients?searchTerm=user
Get info for all users and usergroups whose full name or username matches specified search criteria. These are the recipients that the authenticated user can collaborate with. You obtain the authorization token needed to execute the request using POST /auth/login; you pass the authorization token in the request header. You specify the search criteria with query parameters in the request; the search criteria consist of a search pattern and the value used to evaluate that pattern. For example, you might want to search for all users whose full name or username begin with “S”. You can use other query parameters to limit the results that are returned by specifying a starting point within the results, the maximum number of results, and whether to return only enabled users
Body
PARAM
| Key | Datatype | Required | Description |
searchTerm
|
string | The value that the searchPattern parameter is set to. For example, if the search searchPattern is “Begins with”, this parameter would be the value that the search results would begin with. In this example, if this parameter were set to “B”, the search would return all users and user groups whose full name or username begin with “B”. | |
searchPattern
|
string | The pattern that will be used to search for matching recipients. Possible search patterns include “Begins with”, “Begins with phrase”, “Contains”, “Exactly”, “Ends with”, “Contains any word”, and “None”. This parameter is used together with the searchTerm parameter. | |
targetUserGroupId
|
null | The user group id that specify the target | |
offset
|
number | Starting point within the collection of returned search results. Used to control paging behavior. | |
limit
|
number | Maximum number of items returned for a single request. Used to control paging behavior. Use -1 for no limit. | |
enabledStatus
|
string | Specifies whether to return only enabled users or all users and usergroups that match the search criteria. Available values : ALL, ENABLED_ONLY, LIBRARY_REPORT_ONLY | |
fields
|
n Curl curl -X GET 'baseUrl/api/collaboration/recipients?searchTerm=user?searchTerm=user&searchPattern=CONTAINS_ANY_WORD&targetUserGroupId=&offset=0&limit=-1&enabledStatus=ALL&fields=' -H 'X-MSTR-AuthToken: authToken' ENDPOINTS |