Documents Collaboration

Get Document Team Collaborator

Returns information about the given team's collaboration on the given document, including the team's access and collaboration permissions.

get/v2/documents/{id}/shares/teams/{teamId}

Request

Base URL
https://api.lucid.co
Auth
- HTTP bearer
- or OAuth 2
  Authorization codehttps://lucid.app/oauth2/authorize
  Token URLhttps://api.lucid.co/oauth2/token
  Scopeslucidchart.document.app.folder, lucidchart.document.app.picker.share.collaborator:readonly, lucidchart.document.content.share.collaborator:readonly, lucidscale.document.app.folder, lucidscale.document.app.picker.share.collaborator:readonly, lucidscale.document.content.share.collaborator:readonly, lucidspark.document.app.folder, lucidspark.document.app.picker.share.collaborator:readonly, lucidspark.document.content.share.collaborator:readonly
TypeScript
https://skmtc.dev/lucid/apis/lucid-rest-api/docs/v2/documents/:id/shares/teams/:teamId/get.ts
A function with typed inputs. Its response is checked against the schema.

idstring uuid required

ID of the document.

teamIdstring required

ID of the team to retrieve collaborator settings for, prefixed with team_. The legacy numeric team ID is also accepted.

OK. Returns a Document Team Collaborator Resource containing information about the team's collaboration settings.

documentIdstring uuid required

Document ID

teamIdstring required

Team ID prefixed with team_.

role'owner' | 'editandshare' | 'edit' | 'comment' | 'view' required

The Collaborator Role on the document or folder

createdstring date-time required

Date and time when the collaboration was created

{
  "teamId": "team_99"
}