Skip to main content

Get Auth Settings

GET 
/api/shopify/:integrationInstance/auth-settings

Returns the connection settings for an integration instance with secrets masked (only the last 4 characters are visible), plus the authorization state, current sync status and shop URL. Useful for showing connection state without exposing credentials.

Not yet available to API tokens

This endpoint currently requires session authentication; Personal Access Token scope support is in progress.

Authentication: Requires Bearer token.

Response fields:

  • connection_settings (object): stored settings; consumer_secret, client_secret and password are masked.
  • is_authorized (boolean): true once Shopify has granted an access token for this instance (always true in legacy custom-app mode, which authenticates with stored credentials instead of OAuth). An instance that was created but never completed the handshake reports false.
  • auth_method (string|null): how the grant was made — oauth (the authorization handshake), access_token (an Admin API access token from a custom app created in the merchant's Shopify admin; that app's permissions are managed in Shopify admin, not by re-authorizing), legacy (legacy custom-app mode), or null when never authorized.
  • sync_status (string): Active or Inactive. This is independent of is_authorized — it says whether syncing is switched on, not whether the store is connected.
  • shop_url (string|null): the stored store address.
  • name (string): display name.
  • is_automatic_sync_enabled (boolean).

Every secret in the connection settings (passwords, client and consumer secrets, and any key ending in token, including the Admin API access_token) is masked to its last 4 characters. The public consumer_key is returned as is.

Request​

Responses​

OK

Response Headers
    Content-Type