Profile

Read and update the currently-authenticated user's profile, including display name, email, timezone, and notification preferences.

Preferences schema

Get current user preferences

get

/v1/preferences

Returns UI and account/environment preferences for the currently-authenticated user.

Examples include:

• date/time display formatting (dateFormat, timeFormat)
• current environment selection (environment)
• UI layout preferences (dashboard/pagination/drawer settings)

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Preferences object

application/json

Writable preference fields shared by the request and response schemas.

environmentstring · enumOptional

The selected environment context for the user.

Possible values:

defaultAShareIdstringOptional

The selected account context for the user.

Example: own

defaultEnvIdstring · objectIdOptional

Default environment id to use when applicable.

Example: 60a2c4e6f321d800129a1a3c

dateFormatstring · enumOptional

The user's preferred date display format used across the UI.

Choose one of the supported formats.

Possible values:

timeFormatstring · enumOptional

The user's preferred time display format used across the UI.

Possible values:

showRelativeDateTimebooleanOptional

Whether timestamps should be displayed as relative time (e.g., "5 minutes ago") instead of absolute date/time.

colorThemestring · enumOptional

UI theme preference.

Possible values:

scheduleShiftForFlowsCreatedAfterstring · date-timeOptional

Threshold timestamp used by scheduling logic for certain flows (UI/system preference).

Example: 2024-06-13T11:39:15.778Z

recentActivityobjectOptional

Recently accessed resources, typically keyed by environment.

paginationobjectOptional

Per-resource pagination settings (e.g., pageSize).

drawerOpenedbooleanOptional

When true, the main UI drawer/left nav is open.

expandstring · nullableOptional

UI section name last expanded/opened (UI state).

Example: resources

fbBottomDrawerHeightintegerOptional

Flow Builder bottom drawer height in pixels (UI state).

Example: 240

enableAIChatbotbooleanOptional

When true, AI chat features are enabled in the UI for this user.

enableBeginnerGuidebooleanOptional

When true, the beginner guide UI is enabled for this user.

showIconViewbooleanOptional

When true, Flow Builder icon view is enabled for this user.

allowPostmanCollectionUploadbooleanOptional

When true, Postman collection upload UI is enabled for this user.

helpContentobjectOptional

UI help content preferences/state.

sampleIntegrationRequiredbooleanOptional

When true, the sample-integration walkthrough is still required for the user.

hideGettingStartedbooleanOptional

When true, the Getting Started banner is hidden.

isLeftNavExpandedbooleanOptional

When true, the left navigation sidebar is expanded.

isNewGenFlowEnabledbooleanOptional

When true, the next-generation Flow Builder UI is enabled for the user.

useClickHouseForJobsbooleanOptional

When true, the account uses ClickHouse-backed job queries.

featureFlagsobjectOptional

UI/feature flag overrides for the user (if present).

lastLoginAtstring · date-timeRead-onlyOptional

Last login timestamp recorded for the user (if present).

Example: 2026-05-14T18:22:10.000Z

showReactSneakPeekFromDatestring · dateRead-onlyOptional

Legacy feature-rollout date marker (UI state).

Example: 2025-09-01

showReactBetaFromDatestring · dateRead-onlyOptional

Legacy feature-rollout date marker (UI state).

Example: 2025-11-15

oldDefaultAShareIdstringRead-onlyOptional

Previous default account-share ID, retained after switching accounts.

Example: own

accountsobjectRead-onlyOptional

Per-account UI state keyed by account ID.

401

Unauthorized. The request lacks a valid bearer token, or the provided token failed to authenticate.

Note: the 401 response is produced by the auth middleware before the request reaches the endpoint handler, so it does not follow the standard {errors: [...]} envelope. Instead the body is a bare {message: string} object with no code, no errors array. Callers handling 401s should key off the HTTP status and the message string, not try to destructure an errors[].

application/json

get/v1/preferences

GET /v1/preferences HTTP/1.1
Host: api.integrator.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "environment": "production",
  "defaultAShareId": "own",
  "defaultEnvId": "60a2c4e6f321d800129a1a3c",
  "dateFormat": "MM/DD/YYYY",
  "timeFormat": "h:mm:ss A",
  "colorTheme": "system",
  "showRelativeDateTime": false,
  "drawerOpened": true,
  "enableAIChatbot": true,
  "sampleIntegrationRequired": false,
  "scheduleShiftForFlowsCreatedAfter": "2024-06-13T11:39:15.778Z",
  "lastLoginAt": "2026-05-14T18:22:10.000Z",
  "featureFlags": {
    "enableLookupCache": true,
    "enableSizeBasedAggregation": false
  }
}

Update current user preferences

put

/v1/preferences

Updates user preferences for the currently-authenticated user. Only include fields you intend to change.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Writable preference fields shared by the request and response schemas.

environmentstring · enumOptional

The selected environment context for the user.

Possible values:

defaultAShareIdstringOptional

The selected account context for the user.

Example: own

defaultEnvIdstring · objectIdOptional

Default environment id to use when applicable.

Example: 60a2c4e6f321d800129a1a3c

dateFormatstring · enumOptional

The user's preferred date display format used across the UI.

Choose one of the supported formats.

Possible values:

timeFormatstring · enumOptional

The user's preferred time display format used across the UI.

Possible values:

showRelativeDateTimebooleanOptional

Whether timestamps should be displayed as relative time (e.g., "5 minutes ago") instead of absolute date/time.

colorThemestring · enumOptional

UI theme preference.

Possible values:

scheduleShiftForFlowsCreatedAfterstring · date-timeOptional

Threshold timestamp used by scheduling logic for certain flows (UI/system preference).

Example: 2024-06-13T11:39:15.778Z

recentActivityobjectOptional

Recently accessed resources, typically keyed by environment.

paginationobjectOptional

Per-resource pagination settings (e.g., pageSize).

drawerOpenedbooleanOptional

When true, the main UI drawer/left nav is open.

expandstring · nullableOptional

UI section name last expanded/opened (UI state).

Example: resources

fbBottomDrawerHeightintegerOptional

Flow Builder bottom drawer height in pixels (UI state).

Example: 240

enableAIChatbotbooleanOptional

When true, AI chat features are enabled in the UI for this user.

enableBeginnerGuidebooleanOptional

When true, the beginner guide UI is enabled for this user.

showIconViewbooleanOptional

When true, Flow Builder icon view is enabled for this user.

allowPostmanCollectionUploadbooleanOptional

When true, Postman collection upload UI is enabled for this user.

helpContentobjectOptional

UI help content preferences/state.

sampleIntegrationRequiredbooleanOptional

When true, the sample-integration walkthrough is still required for the user.

hideGettingStartedbooleanOptional

When true, the Getting Started banner is hidden.

isLeftNavExpandedbooleanOptional

When true, the left navigation sidebar is expanded.

isNewGenFlowEnabledbooleanOptional

When true, the next-generation Flow Builder UI is enabled for the user.

useClickHouseForJobsbooleanOptional

When true, the account uses ClickHouse-backed job queries.

featureFlagsobjectOptional

UI/feature flag overrides for the user (if present).

Responses

200

Updated preferences object

application/json

Writable preference fields shared by the request and response schemas.

environmentstring · enumOptional

The selected environment context for the user.

Possible values:

defaultAShareIdstringOptional

The selected account context for the user.

Example: own

defaultEnvIdstring · objectIdOptional

Default environment id to use when applicable.

Example: 60a2c4e6f321d800129a1a3c

dateFormatstring · enumOptional

The user's preferred date display format used across the UI.

Choose one of the supported formats.

Possible values:

timeFormatstring · enumOptional

The user's preferred time display format used across the UI.

Possible values:

showRelativeDateTimebooleanOptional

Whether timestamps should be displayed as relative time (e.g., "5 minutes ago") instead of absolute date/time.

colorThemestring · enumOptional

UI theme preference.

Possible values:

scheduleShiftForFlowsCreatedAfterstring · date-timeOptional

Threshold timestamp used by scheduling logic for certain flows (UI/system preference).

Example: 2024-06-13T11:39:15.778Z

recentActivityobjectOptional

Recently accessed resources, typically keyed by environment.

paginationobjectOptional

Per-resource pagination settings (e.g., pageSize).

drawerOpenedbooleanOptional

When true, the main UI drawer/left nav is open.

expandstring · nullableOptional

UI section name last expanded/opened (UI state).

Example: resources

fbBottomDrawerHeightintegerOptional

Flow Builder bottom drawer height in pixels (UI state).

Example: 240

enableAIChatbotbooleanOptional

When true, AI chat features are enabled in the UI for this user.

enableBeginnerGuidebooleanOptional

When true, the beginner guide UI is enabled for this user.

showIconViewbooleanOptional

When true, Flow Builder icon view is enabled for this user.

allowPostmanCollectionUploadbooleanOptional

When true, Postman collection upload UI is enabled for this user.

helpContentobjectOptional

UI help content preferences/state.

sampleIntegrationRequiredbooleanOptional

When true, the sample-integration walkthrough is still required for the user.

hideGettingStartedbooleanOptional

When true, the Getting Started banner is hidden.

isLeftNavExpandedbooleanOptional

When true, the left navigation sidebar is expanded.

isNewGenFlowEnabledbooleanOptional

When true, the next-generation Flow Builder UI is enabled for the user.

useClickHouseForJobsbooleanOptional

When true, the account uses ClickHouse-backed job queries.

featureFlagsobjectOptional

UI/feature flag overrides for the user (if present).

lastLoginAtstring · date-timeRead-onlyOptional

Last login timestamp recorded for the user (if present).

Example: 2026-05-14T18:22:10.000Z

showReactSneakPeekFromDatestring · dateRead-onlyOptional

Legacy feature-rollout date marker (UI state).

Example: 2025-09-01

showReactBetaFromDatestring · dateRead-onlyOptional

Legacy feature-rollout date marker (UI state).

Example: 2025-11-15

oldDefaultAShareIdstringRead-onlyOptional

Previous default account-share ID, retained after switching accounts.

Example: own

accountsobjectRead-onlyOptional

Per-account UI state keyed by account ID.

204

Preferences updated (no body returned).

400

Bad request. The server could not understand the request because of malformed syntax or invalid parameters.

application/json

401

Unauthorized. The request lacks a valid bearer token, or the provided token failed to authenticate.

Note: the 401 response is produced by the auth middleware before the request reaches the endpoint handler, so it does not follow the standard {errors: [...]} envelope. Instead the body is a bare {message: string} object with no code, no errors array. Callers handling 401s should key off the HTTP status and the message string, not try to destructure an errors[].

application/json

put/v1/preferences

PUT /v1/preferences HTTP/1.1
Host: api.integrator.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "colorTheme": "dark"
}

{
  "environment": "production",
  "defaultAShareId": "own",
  "defaultEnvId": "60a2c4e6f321d800129a1a3c",
  "dateFormat": "MM/DD/YYYY",
  "timeFormat": "h:mm:ss A",
  "colorTheme": "dark",
  "showRelativeDateTime": false,
  "drawerOpened": true,
  "enableAIChatbot": true,
  "sampleIntegrationRequired": false,
  "scheduleShiftForFlowsCreatedAfter": "2024-06-13T11:39:15.778Z",
  "lastLoginAt": "2026-05-14T18:22:10.000Z",
  "featureFlags": {
    "enableLookupCache": true,
    "enableSizeBasedAggregation": false
  }
}