Employments
Employee Personal Details

Show employee personal details

Changed on

Returns the authenticated employee's personal details.

This endpoint requires country-specific data. Query the Show form schema endpoint with personal_details as the form name to discover the schema for a given country.

Authentication

This endpoint requires the following token type:

  • Employee-scoped access token (OAuth2Assertion) — obtained through the urn:ietf:params:oauth:grant-type:jwt-bearer grant. See Authentication for partners.

Scopes

CategoryRead only ScopeWrite only Scope (read access implicit)
Manage employments (employments)View personal details (personal_detail:read)Manage personal details (personal_detail:write)
get/v1/employee/personal-details

Request

  • Base URL: https://gateway.remote.com
  • URL: https://gateway.remote.com/v1/employee/personal-details
  • Auth: OAuth 2 (client credentials, token URL /auth/oauth2/token, scopes: personal_detail:read, personal_detail:write, employments, all:write, all:read)

Query parameters

integer

Specific version number

OR
'latest'

Use latest version

Version of the personal_details form schema

Response

Success

Example response

{
  "data": {
    "employment": {
      "contract_origin": "remote_contract",
      "id": "20a72f86-employment-id-9e4942a902ff",
      "personal_details": {},
      "status": "created",
      "type": "employee",
      "updated_at": "2024-01-15T10:30:00Z",
      "user_status": "active"
    }
  }
}

Changes

  • 9410f5f18a91Revision changes
    • warning

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

  • be4636f25834Revision changes
    • info

      removed the offboarding enum value from the // response property for the response status