Skip to main content
POST
/
api
/
permissions
/
{syncId}
/
streamed-list-objects
Streamed List Objects
curl --request POST \
  --url https://sync.useparagon.com/api/permissions/{syncId}/streamed-list-objects \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "objectType": "file",
  "user": "[email protected]",
  "role": "can_read"
}
'
"<string>"
Use this endpoint when a user may have access to more than 1000 objects and you are using a pre-filtering approach for your search index. For smaller result sets, the buffered List Objects endpoint is simpler to consume.

​
Response format

The response is sent as application/x-ndjson with Transfer-Encoding: chunked. Each line of the response body is a JSON object containing a single object field, whose value is the UUID of a Synced Object the user has access to with the specified role: 
{"object":"a657df3b-17e2-5989-bc5f-13ddb7fdab41"}
{"object":"b842ec1c-2f3a-4a91-9f8d-6cf2b73a1d04"}
{"object":"c91f0a2d-4e58-4b3b-8a1c-7d9e2b0c41ef"}
Parse the response one line at a time. Each line is independently valid JSON; the response body as a whole is not.

Authorizations

​
Authorization
string
header
required

Paragon User Token. Add to the Authorization header of your requests.

Path Parameters

​
syncId
string
required

UUID of the Sync to query, returned from the Enable Sync endpoint.

Body

application/json
​
objectType
enum<string>
required

The type of object to list.

Available options:
file,
folder
Example:

"file"

​
user
string
required

The email of the user to list accessible objects for.

Example:

"[email protected]"

​
role
enum<string>
required

The role to use for identifying accessible objects.

Available options:
can_read,
can_write,
is_owner
Example:

"can_read"

Response

A newline-delimited JSON stream. Each line is a JSON object of the form { "object": "<uuid>" }, where object is the UUID of a Synced Object the user has access to with the specified role.

The response is of type string.