--- title: "Get all data for current user." method: GET path: "/api/v1/current" tags: ["Current"] --- # Get all data for current user. `GET /api/v1/current` ## Request - Base URL: `https://api.intheloop.io` - URL: `https://api.intheloop.io/api/v1/current` - Auth: API key in header `Authorization` ## Query parameters - `getSettings` boolean - `getScopeSettings` boolean - `getSyncSettings` boolean - `getLicense` boolean - `workspaceId` string ## Headers - `Loop-Workspace-Id` string - `Authorization` string - `X-Impersonate-User` string ## Response `200` OK - Current: Current response - `user` User: User contact resource. - `id` string: Resource id - `name` string: Resource name or title - `revision` string: Resource revision - `clientId` string: Resource client id - `$type` string, required - `tags` ListOfTags: List of tags resource - `id` string: Resource id - `name` string: Resource name or title - `revision` string: Resource revision - `clientId` string: Resource client id - `$type` string, required - `tags` ListOfResourcesOfTag: List of resources - `resources` Tag[]: List of resources - `id` string: Resource id - `name` string: Resource name or title - `revision` string: Resource revision - `clientId` string: Resource client id - `$type` string, required - `tagType` string: Tag type. If TagType is the same as Id, that means that this is a system board and can not be altered by clients - `size` integer, required: Page size - `offset` integer, required: Page offset - `offsetHistoryId` string: Offset history id - `totalSize` integer, required: Total size (if total size is at least one bigger than size, then there are more resources). Total size does not necessarily mean the actual total size - `parent` ResourceBase: Resource base - `id` string: Resource id - `name` string: Resource name or title - `revision` string: Resource revision - `clientId` string: Resource client id - `$type` string, required - `weight` number: Usage weight. - `created` string, date-time: Date time of contact creation - `modified` string, date-time: Date time of last time contact was modified - `userIdentificator` string: User's Identificator for EmailUser is email for phone is telephone, .... - `userType` 'EmailUser' | 'ViberUser' | 'MessengerUser' | 'WhatsappUser' | 'PhoneUser', required: User types - `email` string: User's email address - `firstName` string: User's first name - `lastName` string: User's last name - `onlineStatus` string: Online status (possible values can be seen at enums/UserStatus) - `lastActivityAt` string, date-time: Date time of the user's last activity - `displayName` string: User's display name, set only for senders and should be displayed per comment, mostly nullable - `changableDisplayName` boolean: ChangableDisplayName indicates that user has changable name (example github notification user) - `availabilityStatus` AvailabilityUserStatus: Subscription availability status for user - `status` string: Status - `emoji` string: Availability Emoji - `clearAfter` string, date-time: Availability clear after in minutes - `enabledAssignments` boolean, required: Availability available for assignments - `outOfOffice` boolean, required: Availability out of office - `userSettings` UserSettings: User settings resource - `timeZone` string: Timezone in IANA format (reference: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) - `cultureCode` string: Culture code (reference: https://msdn.microsoft.com/en-us/library/ee825488(v=cs.20).aspx) - `haveTwoFactorSecret` boolean, required: Has two secret factor authorization set - `regionCode` string: Region code (reference ISO short: https://msdn.microsoft.com/en-us/library/ee783932(v=cs.10).aspx) - `registeredDate` string, date-time: User's registered date time - `onboardingComplete` boolean: User's onboarding complete status. - `isPasswordVerified` boolean: Is password verified. - `intent` string: Intent - `userClientSettings` UserClientSettings: Users client settings. This settings are only stored on BE side and used only on client side. BE does not implement any logic around this settings. - `showEmailsInAllMessages` boolean, required: Flag to indicate if emails are shown in All messages section. - `showSendEmailsInAllMessages` boolean, required: Flag to indicate if send emails are shown in All messages section. - `enablePrivateTriagingInMyLoopInbox` boolean, required: Flag to indicate if user will see private actions. - `logsDisabled` boolean, required: Flag to indicate if logs are sent form clients - `defaultFromAddress` string: Flag to indicate default from address - `isWorkspaceSwitchAllowed` boolean: Flag to indicate if you can change workspace. - `userAliasSettings` UserAliasSettings: Users alias settings. - `aliases` ListOfResourcesOfUserAlias: List of resources - `resources` UserAlias[]: List of resources - `alias` ContactBase: Contact base resource - `id` string: Resource id - `name` string: Resource name or title - `revision` string: Resource revision - `clientId` string: Resource client id - `$type` string, required - `tags` ListOfTags: List of tags resource - … - `weight` number: Usage weight. - `created` string, date-time: Date time of contact creation - `modified` string, date-time: Date time of last time contact was modified - `enableForSend` boolean, required: Enable for send - `defaultAlias` boolean, required: Default alias - `size` integer, required: Page size - `offset` integer, required: Page offset - `offsetHistoryId` string: Offset history id - `totalSize` integer, required: Total size (if total size is at least one bigger than size, then there are more resources). Total size does not necessarily mean the actual total size - `userPaymentSettings` UserPaymentSettings: Users payment settings. This settings provider user payment status. - `paymentStatusType` 'Trial' | 'Paid' | 'Suspend' | 'WhiteList' | 'PersonalAccount' | 'SharedInbox', required: payment status type - `paymentStatusDate` string, date-time: Flag to indicate if send emails are shown in All messages section. - `userNotificationSettings` UserNotificationSettings: Users client settings. This settings are only stored on BE side and used only on client side. BE does not implement any logic around this settings. - `chatNotification` boolean, required: Flag for sending chat notification. - `mailNotification` boolean, required: Flag for sending mail notification. - `hideSystemMessageNotification` boolean, required: Flag hide system messages. - `notifyNotificationWithSound` boolean, required: Notify notification with sound. - `mobileChatNotification` boolean: Flag for sending chat notification (mobile override). - `mobileMailNotification` boolean: Flag for sending mail notification (mobile override). - `mobileHideSystemMessageNotification` boolean: Flag hide system messages (mobile override). - `mobileNotifyNotificationWithSound` boolean: Notify notification with sound (mobile override). - `syncSettings` SyncSettingsBase: Sync settings base resource - `id` string: Resource id - `name` string: Resource name or title - `revision` string: Resource revision - `clientId` string: Resource client id - `$type` string, required - `isEnabled` boolean: Sync is enabled - `isPaused` boolean: Sync is paused (only contact sync is performed, no emails are imported) - `importDayRange` integer: Email import day range for the past - `threadingMode` 'Recipient' | 'Standard': Threading mode for syncing - `scopeSettings` ListOfResourcesOfScopeSettings: List of resources - `resources` ScopeSettings[]: List of resources - `scopeName` string: Attachment - `keyValues` object: Key value settings - `size` integer, required: Page size - `offset` integer, required: Page offset - `offsetHistoryId` string: Offset history id - `totalSize` integer, required: Total size (if total size is at least one bigger than size, then there are more resources). Total size does not necessarily mean the actual total size - `topLicense` SubscriptionLicense: License resource - `id` string: Resource id - `name` string: Resource name or title - `revision` string: Resource revision - `clientId` string: Resource client id - `$type` string, required - `members` ListOfResourcesOfSubscriptionMember: List of resources - `resources` SubscriptionMember[]: List of resources - `user` ContactBase: Contact base resource - `id` string: Resource id - `name` string: Resource name or title - `revision` string: Resource revision - `clientId` string: Resource client id - `$type` string, required - `tags` ListOfTags: List of tags resource - `id` string: Resource id - `name` string: Resource name or title - `revision` string: Resource revision - `clientId` string: Resource client id - `$type` string, required - `tags` ListOfResourcesOfTag: List of resources - … - `parent` ResourceBase: Resource base - … - `weight` number: Usage weight. - `created` string, date-time: Date time of contact creation - `modified` string, date-time: Date time of last time contact was modified - `role` 'Owner' | 'Admin' | 'Member', required: Subscription Role types - `subscriptionMemberType` 'User' | 'SharedInbox' | 'Personal' | 'SharedInboxAccount' | 'Bot', required: Subscription types - `paymentStatus` string: Payment status - ttemporary remove when FE(dta) will save this document because this is current state - `size` integer, required: Page size - `offset` integer, required: Page offset - `offsetHistoryId` string: Offset history id - `totalSize` integer, required: Total size (if total size is at least one bigger than size, then there are more resources). Total size does not necessarily mean the actual total size - `subscriptionType` SubscriptionType: Subscription type - `id` string: Id of subcription type - `name` string: name of subscription type - `validUntil` string, date-time: Valid until - `numLicenses` integer, required: Num of licenses - `details` SubscriptionDetails: Subscription type - `vouchers` ListOfResourcesOfSubscriptionVoucher: List of resources - `resources` SubscriptionVoucher[]: List of resources - `code` string: Code - `valid` boolean, required: Valid - `validationMessage` string: Validation message - `size` integer, required: Page size - `offset` integer, required: Page offset - `offsetHistoryId` string: Offset history id - `totalSize` integer, required: Total size (if total size is at least one bigger than size, then there are more resources). Total size does not necessarily mean the actual total size - `paidAccounts` SubscriptionPaidAccounts: Paid accounts - `users` integer, required: users count - `sharedInbox` integer, required: shared inbox count - `personal` integer, required: personal count - `teams` integer, required: teams count - `subscriptionStatus` 'Trial' | 'Suspended' | 'Active', required: Subscription Status types - `classificationEnabled` boolean, required: Classification enabled - `aiEnabled` boolean, required: AI enabled - `categoryEnabled` boolean, required: Category enabled - `kioskModeEnabled` boolean, required: Kiosk mode enabled - `directLoopInboxEnabled` boolean, required: Direct LoopInbox enabled (rail Inbox opens LoopInbox without sidebar) - `handleTimeSettings` HandleTimeSettings: Handle Time Settings - `isVisible` boolean, required: Handle Time is visible - `isEnabled` boolean, required: Handle Time is enabled - `idleThresholdSeconds` integer, required: Handle Time idle time - `maxTimeCapSeconds` integer, required: Handle Time max time cap - `uiSettings` UISettings: Represents configuration settings for user interface elements. - `colorScheme` ColorScheme: Represents a set of colors used to define a visual theme or appearance. - `light` ColorPalette: Represents a collection of colors that can be used to define a palette for graphical applications. - `primary` Color: Represents a color value, typically used to define colors in graphical applications or user interfaces. - `base` string: Gets or sets the base color (hex value of color). - `contrast` string: Gets or sets the contrast color (hex value of color). - `secondary` Color: Represents a color value, typically used to define colors in graphical applications or user interfaces. - `base` string: Gets or sets the base color (hex value of color). - `contrast` string: Gets or sets the contrast color (hex value of color). - `tertiary` Color: Represents a color value, typically used to define colors in graphical applications or user interfaces. - `base` string: Gets or sets the base color (hex value of color). - `contrast` string: Gets or sets the contrast color (hex value of color). - `dark` ColorPalette: Represents a collection of colors that can be used to define a palette for graphical applications. - `primary` Color: Represents a color value, typically used to define colors in graphical applications or user interfaces. - `base` string: Gets or sets the base color (hex value of color). - `contrast` string: Gets or sets the contrast color (hex value of color). - `secondary` Color: Represents a color value, typically used to define colors in graphical applications or user interfaces. - `base` string: Gets or sets the base color (hex value of color). - `contrast` string: Gets or sets the contrast color (hex value of color). - `tertiary` Color: Represents a color value, typically used to define colors in graphical applications or user interfaces. - `base` string: Gets or sets the base color (hex value of color). - `contrast` string: Gets or sets the contrast color (hex value of color). - `areDefaultSchemeVisible` boolean, required: Gets or sets a value indicating whether the default color schemes are visible in the user interface. - `logo` string: Workspace Logo - `bumpSettings` 'RepliesAndComments' | 'Comments' | 'Replies' | 'Never', required: Bump settings types - `purgeSettings` PurgeSettings: Represents configuration settings for purge. - `purgeEnabled` boolean, required: Purge is enabled - `gracePeriod` integer, required: Gets or sets grace period in days. - `profileSettings` ProfileSettings: Represents the configuration settings for a user profile. - `profileEnabled` boolean, required: Gets or sets a value indicating whether profiling is enabled. ## Other responses - `400`: Bad request. Check fields message and error code from response body for additional information. - `401`: Unauthorized request. Check fields message and error code from response body for additional information. - `403`: Requested resource forbidden.Check fields message and error code from response body for additional information. - `429`: Too many requests. Check response header Retry-After indicating how long to wait before making a new request. - `451`: Unavailable because account is not verified. --- [API](https://skmtc.dev/intheloop/apis/loop-api.md) - [All operations](https://skmtc.dev/intheloop/apis/loop-api/llms.txt) - [OpenAPI document](https://skmtc.dev/intheloop/apis/loop-api/revisions/0892c5ba0787?raw)