Skip to content
synpute

Grants

Create a grant

Preview

Share a record with another party. Only the record's owner can grant; every read under a grant is logged on the record.

post/v1/grants

Body parameters

expires_atstring | nullrequired
When access ends; omit for until revoked
granteeSynpute IDrequired
Who to share with
resourceSynpute IDrequired
What to share
scopesarray of stringrequired
What they can read

Response 201 · Grant

createdstringrequired
When the record was created
expires_atstring | nullrequired
When access ends; null = until revoked
granteeSynpute IDrequired
Who can read it
idstringrequired
Grant ID
objectstringrequired
Object type
resourceSynpute IDrequired
What is shared
scopesarray of stringrequired
What they can read
statusstringrequired
State
activerevokedexpired

Errors

403404return the standard error shape.