{"slug":"workos-api","name":"WorkOS API","host":"api.workos.com","site":"https://workos.com","category":"identity","docsUrl":null,"sources":[{"kind":"changelog","url":"https://workos.com/changelog"},{"kind":"openapi","url":"https://workos.com/docs/openapi.json"},{"kind":"archive","url":"https://workos.com/docs/reference/magic-link"}],"url":"https://www.okapi.bot/providers/workos-api/","json":"https://www.okapi.bot/api/v1/providers/workos-api.json","breakingChanges":[{"slug":"the-magic-link-api-is-deprecated","api":"workos-api","title":"The Magic Link API is deprecated","kind":"removal","outcome":"fails","model":null,"announcedAt":null,"effectiveAt":null,"scope":null,"calls":["POST /passwordless/sessions*"],"method":"POST","path":"/passwordless/sessions*","source":{"url":"https://workos.com/docs/reference/magic-link","kind":"archive"},"quote":"Magic Link has been replaced by the AuthKit Magic Auth API","migration":"Send a one-time code with POST /user_management/magic_auth and sign the user in with POST /user_management/authenticate (grant type urn:workos:oauth:grant-type:magic-auth:code).","migrationChange":null,"needsDecision":"Magic Auth belongs to AuthKit User Management, which keeps the users in WorkOS: adopting it changes how the app manages users.","text":{"summary":"WorkOS deprecated the Magic Link API without a shutdown date. The deprecation affects requests made to POST /passwordless/sessions*. When removed, calls to these endpoints will fail, as Magic Link has been replaced by the AuthKit Magic Auth API.","migration":"Send a one-time code using POST /user_management/magic_auth and authenticate the user via POST /user_management/authenticate with the urn:workos:oauth:grant-type:magic-auth:code grant type. Adopting Magic Auth requires more than changing an identifier, as it belongs to AuthKit User Management and changes how the application manages users by storing them in WorkOS.","by":"writer"},"publishedAt":"2026-10-23T10:21:30.831Z","updatedAt":"2026-10-26T04:34:42.597Z","status":"deprecated","tone":"deprecated","url":"https://www.okapi.bot/providers/workos-api/breaking-changes/the-magic-link-api-is-deprecated/"}]}