Sign in

v1

latestOpenAPI 3.1.02026-07-242735131.1 MB
Magic Link

Magic links generator

Generates a magic link for a passwordless authentication. To create a magic link for a company admin, you need to provide the user_id parameter. To create a magic link for an employee, you need to provide the employment_id parameter.

Scopes

CategoryRead only ScopeWrite only Scope (read access implicit)
Manage company resources (company_admin)-Create magic links (magic_link:write)
post/v1/magic-link

Headers

Authorizationstring required

Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow.

The refresh token needs to have been obtained through the Authorization Code flow.

Request body

OR

Example request

{
  "user_id": "663e0b79-c893-45ff-a1b2-f6dcabc098b5"
}

Response

Success

Example response

{
  "data": {
    "url": "https://example.com/magic-link"
  }
}