API Reference

Viewer

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Users

Create and invite a new user

viewer.users.invite(UserInviteParams**kwargs) -> UserInviteResponse

post/v1/viewer/users

List users with pagination

viewer.users.list(UserListParams**kwargs) -> SyncCursorUsers[UserListResponse]

get/v1/viewer/users

Retrieve a user by ID

viewer.users.retrieve(struser_id) -> UserRetrieveResponse

get/v1/viewer/users/{userId}

Update a user

viewer.users.update(struser_id, UserUpdateParams**kwargs) -> UserUpdateResponse

patch/v1/viewer/users/{userId}

Revoke user access

viewer.users.revoke_access(UserRevokeAccessParams**kwargs) -> UserRevokeAccessResponse

post/v1/viewer/users/revoke-access

Reactivate a user

viewer.users.reactivate(UserReactivateParams**kwargs) -> UserReactivateResponse

post/v1/viewer/users/reactivate

UsersInvitations

List user invitations

viewer.users.invitations.list(InvitationListParams**kwargs) -> SyncCursorInvitations[InvitationListResponse]

get/v1/viewer/users/invitations

Retrieve an invitation by ID

viewer.users.invitations.retrieve(strinvitation_id) -> InvitationRetrieveResponse

get/v1/viewer/users/invitations/{invitationId}

Update an invitation

viewer.users.invitations.update(strinvitation_id, InvitationUpdateParams**kwargs) -> InvitationUpdateResponse

patch/v1/viewer/users/invitations/{invitationId}

Revoke an invitation

viewer.users.invitations.revoke(InvitationRevokeParams**kwargs) -> InvitationRevokeResponse

post/v1/viewer/users/invitations/revoke