Sign in
integrations

Get Status

Get the status of an integration.

Returns the current connection status, sync history, and activity state.

get/api/v1/integrations/{provider}/status

Request

  • The document declares no server URL.
  • Auth: OAuth 2 (password, token URL /api/v1/auth/token)

Path parameters

provider'immich' required

Supported integration providers.

Add new providers here as they are implemented. Each provider must have a corresponding client module in app/integrations/{provider}.py

Cookies

access_tokenstring nullable

Response

Successful Response

provider'immich' required

Supported integration providers.

Add new providers here as they are implemented. Each provider must have a corresponding client module in app/integrations/{provider}.py

statusstring required

Connection status: 'connected' or 'disconnected'. Provider issues are exposed via last_error.

external_user_idstring nullable

User's ID in the external provider system

connected_atstring date-time nullable

When the integration was first connected

last_synced_atstring date-time nullable

Last successful sync timestamp

last_errorstring nullable

Last error message (if any)

is_activeboolean

Whether the integration is currently enabled

import_mode'link_only' | 'copy'

Import mode for external assets.

Determines how assets are handled when imported from external providers.

album_idstring nullable

Album ID for link mode (Immich provider)

album_errorstring nullable

Error message if album creation/validation failed

Changes

No recorded changes to this operation across all 9 revisions of this API.