Employments
Employment Management

Create bulk employment job

Changed on

Creates a job to bulk-create employments for multiple employees at once. Each employee payload must match the employment schema for the selected country.

Authentication

This endpoint accepts any one of the following token types:

  • Company-scoped access token (OAuth2AuthorizationCode) — obtained through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
  • Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page. See Authorization for customers.

Scopes

CategoryRead only ScopeWrite only Scope (read access implicit)
Manage employments (employments)-Manage employments (employment:write)
post/v1/bulk-employment-jobs

Request

  • Base URL: https://gateway.remote.com
  • URL: https://gateway.remote.com/v1/bulk-employment-jobs
  • Auth: HTTP bearer and OAuth 2 (authorization code, authorization URL /auth/oauth2/authorize, token URL /auth/oauth2/token, scopes: https://gateway.remote.com/company.manage, employment:write, employments, all:write)

Request body

country_codestring required

Country code according to ISO 3166-1 3-digit alphabetic codes.

send_invitationboolean

Batch default for onboarding invitations. Each employee can override it with their own send_invitation value. Defaults to false when omitted.

Example request

{
  "country_code": "SRB",
  "employees": [
    {
      "activate_global_payroll": true,
      "basic_information": {
        "name": "Jane Doe"
      },
      "send_invitation": false
    }
  ],
  "send_invitation": false
}

Response

Accepted

Example response

{
  "data": {
    "column_mapping": {
      "mapping": {
        "basic_info.age": {
          "index": 1,
          "name": "years_old",
          "sample_data": "25"
        },
        "basic_info.name": {
          "index": 0,
          "name": "full_name",
          "sample_data": "Aaron Carter"
        }
      },
      "source_columns": [
        {
          "index": 0,
          "name": "full_name",
          "sample_data": "Aaron Carter"
        },
        {
          "index": 1,
          "name": "years_old",
          "sample_data": "25"
        }
      ],
      "unmapped_column_count": 1,
      "unmapped_required_field_count": 1
    },
    "errors": [],
    "failed_count": 0,
    "finished_at": null,
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "inserted_at": "2021-07-15T18:18:17",
    "inserted_by": {
      "account": {
        "login_email": {
          "address": "jane@remote.com",
          "confirmed_at": null,
          "login_synced": false,
          "status": "pending",
          "type": "login",
          "unconfirmed_address": null
        },
        "login_synced_with": "work",
        "personal_email": {
          "address": "jane@remote.com",
          "confirmed_at": null,
          "login_synced": false,
          "status": "pending",
          "type": "login",
          "unconfirmed_address": null
        },
        "slug": "663e0b79-c893-45ff-a1b2-f6dcabc098b5",
        "status": "created"
      },
      "email": "sauron@remote.com",
      "integration_users": [
        {
          "external_user_id": "123123",
          "integration": {
            "name": "greenhouse"
          },
          "role": "employee",
          "sync_to_remote_status": "enabled"
        }
      ],
      "invited_by": {
        "job_title": "HR Manager",
        "name": "John Smith",
        "slug": "663e0b79-c893-45ff-a1b2-f6dcabc098b5"
      },
      "login_synced_with": "work",
      "name": "Sauron Figueira",
      "personal_details": {
        "birthdate": "2020-02-10",
        "full_preferred_name": "The Warden Hardin",
        "given_name": "Salvor",
        "mobile_number": "9191919191",
        "nationality": [
          "Portugal"
        ],
        "preferred_name": "The Warden",
        "preferred_pronouns": "she/her",
        "recovery_number": "0049123123123",
        "surname": "Hardin",
        "title": "ms"
      },
      "profile_picture": null,
      "raw_email": "sauron+one-2b140@remote.com",
      "role": "employee",
      "signup_source": null,
      "slug": "663e0b79-c893-45ff-a1b2-f6dcabc098b5",
      "status": "active"
    },
    "legal_entity": null,
    "metadata": {
      "extra_metadata": "extra_metadata"
    },
    "name": "import-foobars",
    "processed_count": 0,
    "stage": "submission",
    "status": "finished",
    "total_count": 100,
    "updated_at": "2021-07-15T18:18:17"
  }
}

Changes

  • 09a7e24e0df5Revision changes
    • info

      added the optional property / to the response with the status

  • 9410f5f18a91Revision changes
    • warning

      added the new invited enum value to the /// response property for the response status