GET
/
link
/
url

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

app
required

See supported integrations for list of accepted values. Otherwise, you can create a new custom integration by additionally supplying an authUrl, as well as optionally a displayName, iconUrl, and checkUrl.

appUserId
string
required

Any unique user ID e.g. user-123-xyz.

chromeExtensionId
string | null

Defaults to Anon's chrome extension ID lbgbplnejdpahnfmnphghjlbedpjjbgd. Set this parameter when using your own chrome extension.

companyLogoUrl
string | null

A URL to the company logo. This will be displayed in the Anon Link UI. Defaults to your organization's logo URL if set.

companyName
string | null

The name of your company or application. This will be displayed in the Anon Link UI. Defaults to the name of your organization

redirectUrl
string
required

Any valid url e.g. http://localhost:3000/redirect. This is the url the user will be redirected to after linking an account.

state
string | null

Any valid JSON string e.g. {"key":"value"}. Defaults to {}. This value will be included as a query parameter sent to the specified redirectUrl.

authUrl
string | null

If you are creating a custom integration, set this to the URL of the integration's login page.

checkUrl
string | null

If you are creating a custom integration, set this to a page that can be used to determine whether a user is logged in, such as the user profile page. If not specified, this defaults to the authUrl, which works in many cases.

displayName
string | null

If you are creating a custom integration, set this to the name of the integration as it should appear to the end user.

iconUrl
string | null

If you are creating a custom integration, set this to the url of an icon representing the integration to show to the end user.

Response

200 - application/json
url
string
required