Get login link

  • Updated on Sep 3, 2025
  • Published on Sep 2, 2025
Prev Next
Get
/ds/login/link/{link_id}

Get details of a specific login link

Security
HTTP
Type bearer

Bearer token authentication. Include the token in the Authorization header: Authorization: Bearer <your-token>

Path parameters
link_id
stringRequired

Supermetrics login link ID

Responses
200

Login link details retrieved successfully

Expand All
object
meta
object
request_id
string

API request ID

data
object (LoginLink)
link_id
string

Supermetrics login link ID

status_code
string

Current link status

Valid values[ "OPEN", "CLOSED", "EXPIRED" ]
description
string

Internal link description. Not shown during authentication attempt.

ds_id
string

Data source ID

ds_name
string

Data source name

require_username
string

Data source username that must be used in authentication attempt

redirect_url
string

Custom URL to redirect to after successful authentication, if any

redirect_verifier
string

Internal verifier string that is passed to redirect_url

user_id
string

Supermetrics user ID of the user who will be marked as the primary owner of the login credentials

user_email
string

Supermetrics user email

login_url
string

Full URL to initiate an authentication attempt. Can be accessed multiple times while link is open.

created_time
string (date-time)

ISO 8601 datetime for when login link was created

expiry_time
string (date-time)

ISO 8601 datetime for when login link will expire

login_id
string | null

Supermetrics login ID for a successful authentication

login_time
string (date-time) | null

ISO 8601 datetime for when authentication occurred

login_username
string | null

Username used to authenticate to data source

404

Login Link Not Found

object
error
string
Valid values[ "LINK_NOT_FOUND" ]
message
string