Protocol Documentation

Table of Contents

ai/v2/ai.proto

Top

AnalyzeICalRequest

FieldTypeLabelDescription
ical bytes

AnalyzeICalResponse

FieldTypeLabelDescription
analysis string

TextToICalRequest

FieldTypeLabelDescription
text string

TextToICalResponse

FieldTypeLabelDescription
ical bytes

AIService

Method NameRequest TypeResponse TypeDescription
TextToICal TextToICalRequest TextToICalResponse

AnalyzeICal AnalyzeICalRequest AnalyzeICalResponse

calendars/v2/calendars.proto

Top

CreateCalendarRequest

FieldTypeLabelDescription
name string

ical bytes

description string optional

CreateCalendarResponse

FieldTypeLabelDescription
calendar_id int64

DeleteCalendarRequest

FieldTypeLabelDescription
calendar_id int64

DeleteCalendarResponse

GetCalendarRequest

FieldTypeLabelDescription
calendar_id int64

GetCalendarResponse

FieldTypeLabelDescription
owner_user_id int64

name string

ical bytes

updated_at google.protobuf.Timestamp

description string optional

GetCalendarWritesRequest

FieldTypeLabelDescription
calendar_id int64

GetCalendarWritesResponse

FieldTypeLabelDescription
calendar_write_event_ids int64 repeated

GetCalendarsRequest

GetCalendarsResponse

FieldTypeLabelDescription
calendar_ids int64 repeated

UpdateCalendarRequest

FieldTypeLabelDescription
calendar_id int64

name string optional

description string optional

UpdateCalendarResponse

WriteCalendarRequest

FieldTypeLabelDescription
calendar_id int64

ical bytes

WriteCalendarResponse

CalendarService

Method NameRequest TypeResponse TypeDescription
CreateCalendar CreateCalendarRequest CreateCalendarResponse

GetCalendar GetCalendarRequest GetCalendarResponse

GetCalendars GetCalendarsRequest GetCalendarsResponse

GetCalendarWrites GetCalendarWritesRequest GetCalendarWritesResponse

WriteCalendar WriteCalendarRequest WriteCalendarResponse

UpdateCalendar UpdateCalendarRequest UpdateCalendarResponse

DeleteCalendar DeleteCalendarRequest DeleteCalendarResponse

calendars/v2/writes.proto

Top

GetCalendarWriteRequest

FieldTypeLabelDescription
calendar_write_event_id int64

GetCalendarWriteResponse

FieldTypeLabelDescription
calendar_id int64

writer_user_id int64 optional

ical bytes

created_at google.protobuf.Timestamp

CalendarWriteService

Method NameRequest TypeResponse TypeDescription
GetCalendarWrite GetCalendarWriteRequest GetCalendarWriteResponse

ocr/v2/ocr.proto

Top

ImageToTextRequest

FieldTypeLabelDescription
image bytes

ImageToTextResponse

FieldTypeLabelDescription
text string

OCRService

Method NameRequest TypeResponse TypeDescription
ImageToText ImageToTextRequest ImageToTextResponse

organizations/v2/audit_log.proto

Top

GetCalendarsHistoryRequest

FieldTypeLabelDescription
organization_id int64

GetCalendarsHistoryResponse

FieldTypeLabelDescription
events GetCalendarsHistoryResponse.CalendarEvent repeated

GetCalendarsHistoryResponse.CalendarEvent

FieldTypeLabelDescription
organization_calendar_event_id int64

calendar_id int64

admin_user_id int64 optional

added bool

created_at google.protobuf.Timestamp

GetJoinPromptsHistoryRequest

FieldTypeLabelDescription
organization_id int64

GetJoinPromptsHistoryResponse

FieldTypeLabelDescription
events GetJoinPromptsHistoryResponse.JoinPromptEvent repeated

GetJoinPromptsHistoryResponse.JoinPromptEvent

FieldTypeLabelDescription
join_prompt_event_id int64

owner_user_id int64 optional

prompt string

created_at google.protobuf.Timestamp

GetJoinRequestsHistoryRequest

FieldTypeLabelDescription
organization_id int64

GetJoinRequestsHistoryResponse

FieldTypeLabelDescription
events GetJoinRequestsHistoryResponse.JoinRequestEvent repeated

GetJoinRequestsHistoryResponse.JoinRequestEvent

FieldTypeLabelDescription
join_request_event_id int64

join_response_event_id int64

actor_user_id int64 optional

created_at google.protobuf.Timestamp

status string

GetMemberModerationsHistoryRequest

FieldTypeLabelDescription
organization_id int64

GetMemberModerationsHistoryResponse

FieldTypeLabelDescription
events GetMemberModerationsHistoryResponse.MemberModerationEvent repeated

GetMemberModerationsHistoryResponse.MemberModerationEvent

FieldTypeLabelDescription
member_moderation_event_id int64

member_user_id int64

admin_user_id int64 optional

created_at google.protobuf.Timestamp

reason string

expires_at google.protobuf.Timestamp optional

action string

GetMemberRolesHistoryRequest

FieldTypeLabelDescription
organization_id int64

GetMemberRolesHistoryResponse

FieldTypeLabelDescription
events GetMemberRolesHistoryResponse.MemberRoleEvent repeated

GetMemberRolesHistoryResponse.MemberRoleEvent

FieldTypeLabelDescription
member_role_event_id int64

member_user_id int64

owner_user_id int64 optional

created_at google.protobuf.Timestamp

role string

GetMembersHistoryRequest

FieldTypeLabelDescription
organization_id int64

GetMembersHistoryResponse

FieldTypeLabelDescription
events GetMembersHistoryResponse.MemberEvent repeated

GetMembersHistoryResponse.MemberEvent

FieldTypeLabelDescription
organization_member_event_id int64

member_user_id int64

added bool

created_at google.protobuf.Timestamp

OrganizationAuditLogService

Method NameRequest TypeResponse TypeDescription
GetMembersHistory GetMembersHistoryRequest GetMembersHistoryResponse

GetCalendarsHistory GetCalendarsHistoryRequest GetCalendarsHistoryResponse

GetJoinPromptsHistory GetJoinPromptsHistoryRequest GetJoinPromptsHistoryResponse

GetJoinRequestsHistory GetJoinRequestsHistoryRequest GetJoinRequestsHistoryResponse

GetMemberRolesHistory GetMemberRolesHistoryRequest GetMemberRolesHistoryResponse

GetMemberModerationsHistory GetMemberModerationsHistoryRequest GetMemberModerationsHistoryResponse

organizations/v2/calendars.proto

Top

GetOrganizationCalendarsRequest

FieldTypeLabelDescription
organization_id int64

GetOrganizationCalendarsResponse

FieldTypeLabelDescription
calendar_ids int64 repeated

ToggleShareUserCalendarRequest

FieldTypeLabelDescription
organization_id int64

calendar_id int64

ToggleShareUserCalendarResponse

OrganizationCalendarService

Method NameRequest TypeResponse TypeDescription
ToggleShareUserCalendar ToggleShareUserCalendarRequest ToggleShareUserCalendarResponse

GetOrganizationCalendars GetOrganizationCalendarsRequest GetOrganizationCalendarsResponse

organizations/v2/join_prompts.proto

Top

CreateJoinPromptRequest

FieldTypeLabelDescription
organization_id int64

prompt string

CreateJoinPromptResponse

FieldTypeLabelDescription
join_prompt_event_id int64

GetCurrentJoinPromptRequest

FieldTypeLabelDescription
organization_id int64

GetCurrentJoinPromptResponse

FieldTypeLabelDescription
join_prompt_event_id int64

GetJoinPromptRequest

FieldTypeLabelDescription
join_prompt_event_id int64

GetJoinPromptResponse

FieldTypeLabelDescription
organization_id int64

owner_user_id int64 optional

prompt string

created_at google.protobuf.Timestamp

GetJoinPromptsRequest

FieldTypeLabelDescription
organization_id int64

GetJoinPromptsResponse

FieldTypeLabelDescription
join_prompt_event_ids int64 repeated

OrganizationJoinPromptService

Method NameRequest TypeResponse TypeDescription
CreateJoinPrompt CreateJoinPromptRequest CreateJoinPromptResponse

GetJoinPrompt GetJoinPromptRequest GetJoinPromptResponse

GetJoinPrompts GetJoinPromptsRequest GetJoinPromptsResponse

GetCurrentJoinPrompt GetCurrentJoinPromptRequest GetCurrentJoinPromptResponse

organizations/v2/join_requests.proto

Top

CreateJoinRequestRequest

FieldTypeLabelDescription
join_response_event_id int64

CreateJoinRequestResponse

FieldTypeLabelDescription
join_request_event_id int64

GetJoinRequestRequest

FieldTypeLabelDescription
join_request_event_id int64

GetJoinRequestResponse

FieldTypeLabelDescription
join_response_event_id int64

actor_user_id int64 optional

created_at google.protobuf.Timestamp

status string

GetOpenJoinRequestsRequest

FieldTypeLabelDescription
organization_id int64

GetOpenJoinRequestsResponse

FieldTypeLabelDescription
join_request_event_ids int64 repeated

GetUserJoinRequestsRequest

GetUserJoinRequestsResponse

FieldTypeLabelDescription
join_request_event_ids int64 repeated

ResolveJoinRequestRequest

FieldTypeLabelDescription
organization_id int64

requester_user_id int64

accept bool

ResolveJoinRequestResponse

OrganizationJoinRequestService

Method NameRequest TypeResponse TypeDescription
CreateJoinRequest CreateJoinRequestRequest CreateJoinRequestResponse

GetJoinRequest GetJoinRequestRequest GetJoinRequestResponse

GetOpenJoinRequests GetOpenJoinRequestsRequest GetOpenJoinRequestsResponse

GetUserJoinRequests GetUserJoinRequestsRequest GetUserJoinRequestsResponse

ResolveJoinRequest ResolveJoinRequestRequest ResolveJoinRequestResponse

organizations/v2/join_responses.proto

Top

CreateJoinResponseRequest

FieldTypeLabelDescription
join_prompt_event_id int64

response string

CreateJoinResponseResponse

FieldTypeLabelDescription
join_response_event_id int64

GetJoinResponseRequest

FieldTypeLabelDescription
join_response_event_id int64

GetJoinResponseResponse

FieldTypeLabelDescription
join_prompt_event_id int64

responder_user_id int64

response string

created_at google.protobuf.Timestamp

GetJoinResponsesRequest

GetJoinResponsesResponse

FieldTypeLabelDescription
join_response_event_ids int64 repeated

OrganizationJoinResponseService

Method NameRequest TypeResponse TypeDescription
CreateJoinResponse CreateJoinResponseRequest CreateJoinResponseResponse

GetJoinResponse GetJoinResponseRequest GetJoinResponseResponse

GetJoinResponses GetJoinResponsesRequest GetJoinResponsesResponse

organizations/v2/labels.proto

Top

AttachLabelRequest

FieldTypeLabelDescription
organization_label_id int64

calendar_id int64

AttachLabelResponse

CreateLabelRequest

FieldTypeLabelDescription
organization_id int64

name string

color string

CreateLabelResponse

FieldTypeLabelDescription
organization_label_id int64

DeleteLabelRequest

FieldTypeLabelDescription
organization_label_id int64

DeleteLabelResponse

DetachLabelRequest

FieldTypeLabelDescription
organization_label_id int64

calendar_id int64

DetachLabelResponse

GetCalendarLabelsRequest

FieldTypeLabelDescription
calendar_id int64

GetCalendarLabelsResponse

FieldTypeLabelDescription
organization_label_ids int64 repeated

GetLabelRequest

FieldTypeLabelDescription
organization_label_id int64

GetLabelResponse

FieldTypeLabelDescription
name string

color string

GetLabelsRequest

FieldTypeLabelDescription
organization_id int64

GetLabelsResponse

FieldTypeLabelDescription
organization_label_ids int64 repeated

UpdateLabelRequest

FieldTypeLabelDescription
organization_label_id int64

name string optional

color string optional

UpdateLabelResponse

OrganizationLabelService

Method NameRequest TypeResponse TypeDescription
CreateLabel CreateLabelRequest CreateLabelResponse

GetLabel GetLabelRequest GetLabelResponse

GetLabels GetLabelsRequest GetLabelsResponse

GetCalendarLabels GetCalendarLabelsRequest GetCalendarLabelsResponse

UpdateLabel UpdateLabelRequest UpdateLabelResponse

DeleteLabel DeleteLabelRequest DeleteLabelResponse

AttachLabel AttachLabelRequest AttachLabelResponse

DetachLabel DetachLabelRequest DetachLabelResponse

organizations/v2/member_roles.proto

Top

GetMemberRoleRequest

FieldTypeLabelDescription
organization_id int64

member_user_id int64

GetMemberRoleResponse

FieldTypeLabelDescription
role string

SetMemberRoleRequest

FieldTypeLabelDescription
organization_id int64

member_user_id int64

role string

SetMemberRoleResponse

OrganizationMemberRoleService

Method NameRequest TypeResponse TypeDescription
GetMemberRole GetMemberRoleRequest GetMemberRoleResponse

SetMemberRole SetMemberRoleRequest SetMemberRoleResponse

organizations/v2/memberships.proto

Top

GetOrganizationMembersRequest

FieldTypeLabelDescription
organization_id int64

GetOrganizationMembersResponse

FieldTypeLabelDescription
member_user_ids int64 repeated

JoinOrganizationRequest

FieldTypeLabelDescription
organization_id int64

JoinOrganizationResponse

LeaveOrganizationRequest

FieldTypeLabelDescription
organization_id int64

LeaveOrganizationResponse

OrganizationMembershipService

Method NameRequest TypeResponse TypeDescription
GetOrganizationMembers GetOrganizationMembersRequest GetOrganizationMembersResponse

JoinOrganization JoinOrganizationRequest JoinOrganizationResponse

LeaveOrganization LeaveOrganizationRequest LeaveOrganizationResponse

organizations/v2/moderations.proto

Top

BanMemberRequest

FieldTypeLabelDescription
organization_id int64

member_user_id int64

reason string

expires_at_secs int64 optional

BanMemberResponse

UnbanMemberRequest

FieldTypeLabelDescription
organization_id int64

member_user_id int64

reason string

UnbanMemberResponse

OrganizationModerationService

Method NameRequest TypeResponse TypeDescription
BanMember BanMemberRequest BanMemberResponse

UnbanMember UnbanMemberRequest UnbanMemberResponse

organizations/v2/organizations.proto

Top

CreateOrganizationRequest

FieldTypeLabelDescription
name string

requires_join_request bool

description string optional

CreateOrganizationResponse

FieldTypeLabelDescription
organization_id int64

DeleteOrganizationRequest

FieldTypeLabelDescription
organization_id int64

DeleteOrganizationResponse

GetOrganizationRequest

FieldTypeLabelDescription
organization_id int64

GetOrganizationResponse

FieldTypeLabelDescription
name string

requires_join_request bool

created_at google.protobuf.Timestamp

description string optional

GetOrganizationsRequest

GetOrganizationsResponse

FieldTypeLabelDescription
organization_ids int64 repeated

GetUserOrganizationsRequest

GetUserOrganizationsResponse

FieldTypeLabelDescription
organization_ids int64 repeated

UpdateOrganizationRequest

FieldTypeLabelDescription
organization_id int64

name string optional

requires_join_request bool optional

description string optional

UpdateOrganizationResponse

OrganizationService

Method NameRequest TypeResponse TypeDescription
CreateOrganization CreateOrganizationRequest CreateOrganizationResponse

GetOrganization GetOrganizationRequest GetOrganizationResponse

GetOrganizations GetOrganizationsRequest GetOrganizationsResponse

GetUserOrganizations GetUserOrganizationsRequest GetUserOrganizationsResponse

UpdateOrganization UpdateOrganizationRequest UpdateOrganizationResponse

DeleteOrganization DeleteOrganizationRequest DeleteOrganizationResponse

users/v2/labels.proto

Top

AttachUserLabelRequest

FieldTypeLabelDescription
user_label_id int64

calendar_id int64

AttachUserLabelResponse

CreateUserLabelRequest

FieldTypeLabelDescription
name string

color string

CreateUserLabelResponse

FieldTypeLabelDescription
user_label_id int64

DeleteUserLabelRequest

FieldTypeLabelDescription
user_label_id int64

DeleteUserLabelResponse

DetachUserLabelRequest

FieldTypeLabelDescription
user_label_id int64

calendar_id int64

DetachUserLabelResponse

GetUserCalendarLabelsRequest

FieldTypeLabelDescription
calendar_id int64

GetUserCalendarLabelsResponse

FieldTypeLabelDescription
user_label_ids int64 repeated

GetUserLabelRequest

FieldTypeLabelDescription
user_label_id int64

GetUserLabelResponse

FieldTypeLabelDescription
name string

color string

GetUserLabelsRequest

GetUserLabelsResponse

FieldTypeLabelDescription
user_label_ids int64 repeated

UpdateUserLabelRequest

FieldTypeLabelDescription
user_label_id int64

name string optional

color string optional

UpdateUserLabelResponse

UserLabelService

Method NameRequest TypeResponse TypeDescription
CreateUserLabel CreateUserLabelRequest CreateUserLabelResponse

GetUserLabel GetUserLabelRequest GetUserLabelResponse

GetUserLabels GetUserLabelsRequest GetUserLabelsResponse

GetUserCalendarLabels GetUserCalendarLabelsRequest GetUserCalendarLabelsResponse

UpdateUserLabel UpdateUserLabelRequest UpdateUserLabelResponse

DeleteUserLabel DeleteUserLabelRequest DeleteUserLabelResponse

AttachUserLabel AttachUserLabelRequest AttachUserLabelResponse

DetachUserLabel DetachUserLabelRequest DetachUserLabelResponse

users/v2/sessions.proto

Top

GetSessionUserIDRequest

GetSessionUserIDResponse

FieldTypeLabelDescription
user_id int64

RevokeAllSessionsRequest

RevokeAllSessionsResponse

RevokeSessionRequest

RevokeSessionResponse

UserSessionService

Method NameRequest TypeResponse TypeDescription
GetSessionUserID GetSessionUserIDRequest GetSessionUserIDResponse

RevokeSession RevokeSessionRequest RevokeSessionResponse

RevokeAllSessions RevokeAllSessionsRequest RevokeAllSessionsResponse

users/v2/users.proto

Top

CreateUserRequest

FieldTypeLabelDescription
email string

first_name string

last_name string

password string

middle_name string optional

CreateUserResponse

FieldTypeLabelDescription
session_token string

DeleteUserRequest

DeleteUserResponse

GetUserEmailRequest

GetUserEmailResponse

FieldTypeLabelDescription
email string

GetUserRequest

FieldTypeLabelDescription
user_id int64

GetUserResponse

FieldTypeLabelDescription
first_name string

last_name string

middle_name string optional

LoginUserRequest

FieldTypeLabelDescription
email string

password string

LoginUserResponse

FieldTypeLabelDescription
session_token string

UpdateLoginUserRequest

FieldTypeLabelDescription
email string optional

password string optional

UpdateLoginUserResponse

UpdateUserRequest

FieldTypeLabelDescription
first_name string optional

last_name string optional

middle_name string optional

UpdateUserResponse

UserService

Method NameRequest TypeResponse TypeDescription
CreateUser CreateUserRequest CreateUserResponse

LoginUser LoginUserRequest LoginUserResponse

GetUser GetUserRequest GetUserResponse

GetUserEmail GetUserEmailRequest GetUserEmailResponse

UpdateUser UpdateUserRequest UpdateUserResponse

UpdateLoginUser UpdateLoginUserRequest UpdateLoginUserResponse

DeleteUser DeleteUserRequest DeleteUserResponse

Scalar Value Types

.proto TypeNotesC++JavaPythonGoC#PHPRuby
double double double float float64 double float Float
float float float float float32 float float Float
int32 Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. int32 int int int32 int integer Bignum or Fixnum (as required)
int64 Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. int64 long int/long int64 long integer/string Bignum
uint32 Uses variable-length encoding. uint32 int int/long uint32 uint integer Bignum or Fixnum (as required)
uint64 Uses variable-length encoding. uint64 long int/long uint64 ulong integer/string Bignum or Fixnum (as required)
sint32 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. int32 int int int32 int integer Bignum or Fixnum (as required)
sint64 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. int64 long int/long int64 long integer/string Bignum
fixed32 Always four bytes. More efficient than uint32 if values are often greater than 2^28. uint32 int int uint32 uint integer Bignum or Fixnum (as required)
fixed64 Always eight bytes. More efficient than uint64 if values are often greater than 2^56. uint64 long int/long uint64 ulong integer/string Bignum
sfixed32 Always four bytes. int32 int int int32 int integer Bignum or Fixnum (as required)
sfixed64 Always eight bytes. int64 long int/long int64 long integer/string Bignum
bool bool boolean boolean bool bool boolean TrueClass/FalseClass
string A string must always contain UTF-8 encoded or 7-bit ASCII text. string String str/unicode string string string String (UTF-8)
bytes May contain any arbitrary sequence of bytes. string ByteString str []byte ByteString string String (ASCII-8BIT)