Get a grant | Sigma Documentation

Return a grant object by grant ID.

Depending on the grant object that you want to return details about, you can retrieve the grantId in different ways:

For most documents, you can retrieve the grantId by calling the /v2/grants endpoint with the inodeId for the document. For example, use the workbookId as the inodeId.
For a dataset (deprecated), you can also retrieve the grantId by calling the /v2/datasets/{datasetId}/grants endpoint.
For a connection path, you can retrieve the grantId by calling the /v2/connections/paths/{connectionPathId}/grants endpoint.

AuthorizationBearer

OAuth authentication of the form <token>.

grantIdstringRequired

The response body.

grantIdstring

The unique identifier of the grant

inodeIdstring

The unique identifier of the inode

organizationIdstring

The unique identifier of the organization

memberIdstring or null

The unique identifier of the member

teamIdstring or null

The unique identifier of the team

permissionenum

The permission granted to the member

createdBystring

The identifier of the user who created this grant

updatedBystring

The identifier of the user or process that last updated this grant

createdAtdatetime

When the grant was created

updatedAtdatetime

When the grant was last updated

inodeTypeenum