List grants

GET

/v1/workspaces/{workspaceId}/grants

const url = 'https://shareout.site/v1/workspaces/example/grants?resource_type=folder';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://shareout.site/v1/workspaces/example/grants?resource_type=folder' \
  --header 'Authorization: Bearer <token>'

Authorizations

bearerAuth

Parameters

Path Parameters

workspaceId

required

string

Workspace ID or slug.

Query Parameters

subject_id

string

resource_type

string

Allowed values: folder artifact file

resource_id

string

Responses

200

Grants

application/json

object

grants

Array<object>

object

string

subject_type

string

Allowed values: sharee external_user

subject_id

string

resource_type

string

Allowed values: folder artifact file

resource_id

string

capability

string

Allowed values: view comment create edit

Example

{
  "grants": [
    {
      "subject_type": "sharee",
      "resource_type": "folder",
      "capability": "view"
    }
  ]
}