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

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"

​
user
string
required

The email of the user to check permissions for.

Example:

"[email protected]"

​
role
enum<string>
required

The role to use for the access check.

Available options:
can_read,
can_write,
is_owner

Response

Access check result

​
hasAccess
boolean

Returns true if the user has access to the Synced Object with the specified role.

⌘I