External sharing

Create a grant

Workspace admins, with the external-sharing entitlement (403 EXTERNAL_SHARING_NOT_ENTITLED otherwise).

post/v1/workspaces/{workspaceId}/grants

Request

subject_type'sharee' | 'external_user' required

subject_idstring required

resource_type'folder' | 'artifact' | 'file' required

resource_idstring required

capability'view' | 'comment' | 'create' | 'edit' required

Created

idstring

subject_type'sharee' | 'external_user' | 'guest'

subject_idstring

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

resource_type'folder' | 'artifact' | 'file'

resource_idstring

capability'view' | 'comment' | 'create' | 'edit'

granted_bystring

created_atstring date-time

expires_atstring date-time nullable

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

subject_labelstring

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

Oct 17, 2026a43d748cfdda Revision changes
- warning
  added the new guest enum value to the response property for the response status
Oct 16, 2026924c2aeaed12 Revision changes
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status