Swagger Petstore - OpenAPI 3.0
POST/v1/accounts/{account}/login_links

Create a login link for an account

Creates a login link for a connected account to access the Express Dashboard. The account must use the Express Dashboard and be connected to your platform. Returns a single-use URL that takes the account directly to their dashboard login page.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 1 body field
accountstringrequired

The unique identifier of the connected account to create a login link for.

Optional request parameters.

expandarray<string>optional

Specifies which fields in the response should be expanded.

2 status codes
200Returns a login link object containing the URL, creation timestamp, and object type.
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.

Allowed:login_link
urlstringrequired

The URL for the login link.

defaultError response.
errorobjectrequired

Error handling

account must identify a connected account that uses the Express Dashboard. The expand parameter accepts field names to include nested details in the response.