POST
/v1/accounts/{account}/login_linksCreate a login link
Creates a single-use login link for a connected account to access the Express Dashboard. Use account for an account connected to your platform and using the Express Dashboard; optionally use expand to expand response fields. The response contains the login URL and its creation time.
- RetriesRetries up to 2×, 500ms backoff, 30s timeout.
- IdempotentThe SDK sends
Idempotency-Key, so a retried request is only applied once.
accountstringrequired
The connected account for which to create an Express Dashboard login link. Maximum 5000 characters.
Optional form data controlling which response fields are expanded.
expandarray<string>optional
Specifies which fields in the response should be expanded.
200Returns a login link object containing the single-use `url`, its Unix creation time in `created`, and the object type `login_link`.
createdintegerrequired
Time at which the object was created. Measured in seconds since the Unix epoch.
objectstringrequired
String representing the object's type. Objects of the same type share the same value.
urlstringrequired
The URL for the login link.
defaultReturned when the request cannot be processed; the response contains an API error object with an error type and related details.
errorobjectrequired
Error handling
account must identify a connected account that uses the Express Dashboard and must not exceed 5000 characters. Each expand value must be a string no longer than 5000 characters.