Skip to content
Get started

Users

Create and invite a new user
client.viewer.users.invite(UserInviteParams { canManageStudies, clinicRole, email, 8 more } body, RequestOptionsoptions?): UserInviteResponse { canManageStudies, clinicRole, createdAt, 12 more }
post/v1/viewer/users
List users with pagination
client.viewer.users.list(UserListParams { cursor, email, firstName, 4 more } query?, RequestOptionsoptions?): CursorUsers<UserListResponse { canManageStudies, clinicRole, createdAt, 12 more } >
get/v1/viewer/users
Retrieve a user by ID
client.viewer.users.retrieve(stringuserID, RequestOptionsoptions?): UserRetrieveResponse { canManageStudies, clinicRole, createdAt, 12 more }
get/v1/viewer/users/{userId}
Update a user
client.viewer.users.update(stringuserID, UserUpdateParams { canManageStudies, clinicRole, firstName, 7 more } body?, RequestOptionsoptions?): UserUpdateResponse { canManageStudies, clinicRole, createdAt, 12 more }
patch/v1/viewer/users/{userId}
Revoke user access
client.viewer.users.revokeAccess(UserRevokeAccessParams { userId } body, RequestOptionsoptions?): UserRevokeAccessResponse { success, message }
post/v1/viewer/users/revoke-access
Reactivate a user
client.viewer.users.reactivate(UserReactivateParams { userId } body, RequestOptionsoptions?): UserReactivateResponse { success, message }
post/v1/viewer/users/reactivate

UsersInvitations

List user invitations
client.viewer.users.invitations.list(InvitationListParams { cursor, endDate, expired, 4 more } query?, RequestOptionsoptions?): CursorInvitations<InvitationListResponse { canManageStudies, clinicId, clinicRole, 18 more } >
get/v1/viewer/users/invitations
Retrieve an invitation by ID
client.viewer.users.invitations.retrieve(stringinvitationID, RequestOptionsoptions?): InvitationRetrieveResponse { canManageStudies, clinicId, clinicRole, 18 more }
get/v1/viewer/users/invitations/{invitationId}
Update an invitation
client.viewer.users.invitations.update(stringinvitationID, InvitationUpdateParams { canManageStudies, clinicRole, firstName, 7 more } body?, RequestOptionsoptions?): InvitationUpdateResponse { canManageStudies, clinicId, clinicRole, 18 more }
patch/v1/viewer/users/invitations/{invitationId}
Revoke an invitation
client.viewer.users.invitations.revoke(InvitationRevokeParams { invitationId, userId } body?, RequestOptionsoptions?): InvitationRevokeResponse { success, message }
post/v1/viewer/users/invitations/revoke