OCS Recipient API
Table of Contents
Introduction
The OCS Recipient API is a new OCS endpoint that is used by the share dialog autocomplete process, when you pick a user or group to share to.
The base URL for all calls to the share API is: <owncloud_base_url>/ocs/v1.php/apps/files_sharing/api/v1/sharees?format=json
Get Shares Recipients
Get all share recipients for the provided search term.
-
Syntax: /sharees
-
Method: GET
Query Attributes
| Attribute | Type | Description | Required | Default |
|---|---|---|---|---|
format |
string |
The response format. Can be either |
|
|
search |
string |
The search string |
||
itemType |
string |
The type which is shared. |
Yes |
|
Can be either |
||||
shareType |
integer |
Any one of: |
||
- 0 (user) |
||||
- 1 (group) |
||||
- 6 (remote) |
||||
page |
integer |
The page number in the results to be returned |
1 |
|
perPage |
integer |
The number of items per page |
Yes |
200 |