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>'

Workspace admins. A folder’s manager (an admin, or the member who created it while members manage their folders) may also list the grants on that one folder with resource_type=folder&resource_id=…. Not gated on the external-sharing entitlement, so existing access can always be reviewed.

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 guest

subject_id

Sharee id, users.id, or for a guest grant the guest’s email.

string

resource_type

string

Allowed values: folder artifact file

resource_id

string

capability

string

Allowed values: view comment create edit

granted_by

string

created_at

string format: date-time

expires_at

When access ends (share-with-a-person expiry); null = never. A lapsed grant is denied at read time.

string | null format: date-time

subject_label

The person’s email or the client’s name (list endpoint).

string

Example

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