Skip to main content
POST
/
api
/
permissions
/
{syncId}
/
list-users
List Users
curl --request POST \
  --url https://sync.useparagon.com/api/permissions/{syncId}/list-users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "object": "a657df3b-17e2-5989-bc5f-13ddb7fdab41",
  "role": "can_read"
}
'
{
  "users": [
    "[email protected]"
  ]
}
Responses from this endpoint are limited to 1000 users by default.If your use case involves checking permissions for 1000+ users per file, see our Permissions API Implementation Guide for guidance on using other available endpoints.

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
​
object
string
required

UUID of the Synced Object, returned from the Pull Synced Records endpoint.

Example:

"a657df3b-17e2-5989-bc5f-13ddb7fdab41"

​
role
enum<string>
required

The role to filter related users by.

Available options:
can_read,
can_write,
is_owner

Response

​
users
string[]

List of user emails that have access to the Synced Object with the specified role.