Remote

Remote Magic Links API

Generate passwordless magic links for users and employees

Documentation GitHub OpenAPI

Documentation

https://developer.remote.com/reference/welcome-to-remote-api

https://developer.remote.com/docs/creating-a-company

https://developer.remote.com/docs/create-new-employment

https://developer.remote.com/docs/employment-lifecycle-stages

https://developer.remote.com/docs/employment-statuses

https://developer.remote.com/docs/quick-start-guide-2

https://developer.remote.com/docs/working-with-expenses

https://developer.remote.com/docs/working-with-incentives

https://developer.remote.com/docs/working-with-time-off

https://developer.remote.com/docs/leave-policies-summary

https://developer.remote.com/docs/working-with-timesheets

https://developer.remote.com/docs/benefits-renewal

https://developer.remote.com/docs/working-with-files

https://developer.remote.com/docs/custom-fields

https://developer.remote.com/docs/working-with-countries

https://developer.remote.com/docs/employment-cost-estimation

https://developer.remote.com/docs/authentication

https://developer.remote.com/docs/authorization-for-customers

https://developer.remote.com/docs/client-credentials-flow-for-partners

https://developer.remote.com/docs/authorization-method-oauth-assertion

https://developer.remote.com/docs/refresh-token-flow

Specifications

https://raw.githubusercontent.com/api-evangelist/remote-com/refs/heads/main/openapi/remote-com-magic-links-api-openapi.yml

Schemas & Data

https://raw.githubusercontent.com/api-evangelist/remote-com/refs/heads/main/json-schema/remote-company-schema.json

https://raw.githubusercontent.com/api-evangelist/remote-com/refs/heads/main/json-schema/remote-employment-schema.json

https://raw.githubusercontent.com/api-evangelist/remote-com/refs/heads/main/json-schema/remote-billing-document-schema.json

https://raw.githubusercontent.com/api-evangelist/remote-com/refs/heads/main/json-schema/remote-time-off-schema.json

Other Resources

https://raw.githubusercontent.com/api-evangelist/remote-com/refs/heads/main/json-ld/remote-com-context.jsonld

https://raw.githubusercontent.com/api-evangelist/remote-com/refs/heads/main/examples/remote-create-employment-example.json

https://raw.githubusercontent.com/api-evangelist/remote-com/refs/heads/main/examples/remote-create-timeoff-example.json

https://raw.githubusercontent.com/api-evangelist/remote-com/refs/heads/main/examples/remote-cost-estimate-example.json

https://raw.githubusercontent.com/api-evangelist/remote-com/refs/heads/main/examples/remote-oauth-token-exchange-example.json

OpenAPI Specification

openapi: 3.1.0
info:
  title: Remote Benefits Benefit Offers Magic Links API
  description: 'List, select, and renew localized employee benefits across the countries

    Remote supports. Benefit offers and renewal requests use JSON Schema

    forms that vary per country and employment.

    '
  version: '2026-05-22'
  contact:
    name: Remote API Support
    url: https://support.remote.com/
  x-logo:
    url: https://remote.com/favicon.ico
servers:
- url: https://gateway.remote.com/v1
  description: Production
- url: https://gateway.remote-sandbox.com/v1
  description: Sandbox
security:
- BearerAuth: []
tags:
- name: Magic Links
  description: Generate passwordless magic links for users and employees
paths:
  /magic_links:
    post:
      summary: Generate A Magic Link
      description: 'Generate a single-use magic link to log a user (`user_id`) or

        employee (`employment_id`) into Remote without a password.

        '
      operationId: generateMagicLink
      tags:
      - Magic Links
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MagicLinkRequest'
      responses:
        '201':
          description: Magic link.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MagicLinkResponse'
components:
  schemas:
    MagicLinkResponse:
      type: object
      properties:
        data:
          type: object
          properties:
            magic_link:
              type: string
              format: uri
            expires_at:
              type: string
              format: date-time
    MagicLinkRequest:
      type: object
      properties:
        user_id:
          type: string
          format: uuid
        employment_id:
          type: string
          format: uuid
        timeout_in_minutes:
          type: integer
          minimum: 1
          maximum: 1440
          default: 15
        target_section:
          type: string
          description: Optional Remote UI section to deep-link to.
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT