Skip to main content
POST
/
api
/
permissions
/
{syncId}
/
list-objects
List Objects
curl --request POST \
  --url https://sync.useparagon.com/api/permissions/{syncId}/list-objects \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "objectType": "file",
  "user": "[email protected]",
  "role": "can_read"
}
'
{
  "objects": [
    "a657df3b-17e2-5989-bc5f-13ddb7fdab41"
  ]
}

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
​
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

Response

List of Synced Objects that the user has access to with the specified role.

​
objects
string[]

UUID of a Synced Object, which can be referenced in the Get Synced Record endpoint.